-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #35 from SF-Tec/chore/typos
- Loading branch information
Showing
7 changed files
with
125 additions
and
119 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,65 @@ | ||
| ## Pyvium and Core methods | ||
|
|
||
| :heavy_check_mark: ready | ||
| :small_orange_diamond: under development | ||
| :x: not working | ||
|
|
||
| | Pyvium Methods | Core Methods | | ||
| | ----------------------------------------------------- | ----------------------------------------- | | ||
| | :heavy_check_mark: open_driver() | :heavy_check_mark: IV_open() | | ||
| | :heavy_check_mark: close_driver() | :heavy_check_mark: IV_close() | | ||
| | :heavy_check_mark: get_max_device_number() | :heavy_check_mark: IV_MaxDevices() | | ||
| | :heavy_check_mark: get_active_iviumsoft_instances(int)| | | ||
| | :heavy_check_mark: select_iviumsoft_instance(int) | :heavy_check_mark: IV_selectdevice(int) | | ||
| | :heavy_check_mark: get_device_status() | :heavy_check_mark: IV_getdevicestatus() | | ||
| | :heavy_check_mark: is_iviumsoft_running() | | | ||
| | :heavy_check_mark: get_device_serial_number() | :heavy_check_mark: IV_readSN() | | ||
| | :heavy_check_mark: connect_device() | :heavy_check_mark: IV_connect(int) | | ||
| | :heavy_check_mark: disconnect_device() | :heavy_check_mark: IV_connect(int) | | ||
| | | :heavy_check_mark: IV_VersionHost(version)| | ||
| | :heavy_check_mark: get_dll_version() | :heavy_check_mark: IV_VersionDll() | | ||
| | | :heavy_check_mark: IV_VersionCheck() | | ||
| | | :heavy_check_mark: IV_HostHandle() | | ||
| | :heavy_check_mark: get_iviumsoft_version() | :heavy_check_mark: IV_VersionDllFile() | | ||
| | | :heavy_check_mark: IV_VersionDllFileStr() | | ||
| | :heavy_check_mark: select_channel(int) | :heavy_check_mark: IV_SelectChannel(int) | | ||
| | :heavy_check_mark: get_cell_status() | :heavy_check_mark: IV_getcellstatus() | | ||
| | :heavy_check_mark: set_connection_mode(int) | :heavy_check_mark: IV_setconnectionmode(int) | | ||
| | :heavy_check_mark: set_cell_on() | :heavy_check_mark: IV_setcellon(int) | | ||
| | :heavy_check_mark: set_cell_off() | | | ||
| | :heavy_check_mark: set_potential(float) | :heavy_check_mark: IV_setpotential(float)| | ||
| | :heavy_check_mark: set_we2_potential(float) | :heavy_check_mark: IV_setpotentialWE2(float)| | ||
| | :heavy_check_mark: set_curretn(float) | :heavy_check_mark: IV_setcurrent(float)| | ||
| | :heavy_check_mark: get_potential() | :heavy_check_mark: IV_getpotential()| | ||
| | :heavy_check_mark: set_current_range(int) | :heavy_check_mark: IV_setcurrentrange(int)| | ||
| | :heavy_check_mark: set_we2_current_range(int) | :heavy_check_mark: IV_setcurrentrangeWE2(int)| | ||
| | :heavy_check_mark: get_current() | :heavy_check_mark: IV_getcurrent()| | ||
| | :heavy_check_mark: get_we2_current() | :heavy_check_mark: IV_getcurrentWE2()| | ||
| | :heavy_check_mark: set_filter(int) | :heavy_check_mark: IV_setfilter(int)| | ||
| | :heavy_check_mark: set_stability(int) | :heavy_check_mark: IV_setstability(int)| | ||
| | :heavy_check_mark: set_bistat_mode(int) | :heavy_check_mark: IV_setbistatmode(int)| | ||
| | :heavy_check_mark: set_dac(int, float) | :heavy_check_mark: IV_setdac(int, float)| | ||
| | :heavy_check_mark: set_adc(int) | :heavy_check_mark: IV_getadc(int) | | ||
| | :heavy_check_mark: set_mux_channel(int) | :heavy_check_mark: IV_setmuxchannel(int)| | ||
| | | :heavy_check_mark: IV_setdigout(value)| | ||
| | | :heavy_check_mark: IV_getdigin(value)| | ||
| | :heavy_check_mark: set_ac_frequency(float) | :heavy_check_mark: IV_setfrequency(value)| | ||
| | :heavy_check_mark: set_ac_amplitude(float) | :heavy_check_mark: IV_setamplitude(value)| | ||
| | | :heavy_check_mark: IV_getcurrenttrace(npoints, rate, values)| | ||
| | | :heavy_check_mark: IV_getcurrentWE2trace(npoints, rate, values)| | ||
| | | :heavy_check_mark: IV_getpotentialtrace(npoints, rate, values)| | ||
| | | :heavy_check_mark: IV_we32setchannel(index)| | ||
| | | :heavy_check_mark: IV_we32setoffset(index, value)| | ||
| | | :heavy_check_mark: IV_we32setoffsets(nval, values)| | ||
| | | :heavy_check_mark: IV_we32getoffsets(nval, values)| | ||
| | | :heavy_check_mark: IV_we32readcurrents(values)| | ||
| | :heavy_check_mark: load_method(str) | :heavy_check_mark: IV_readmethod(fname)| | ||
| | :heavy_check_mark: save_method(str) | :heavy_check_mark: IV_savemethod(fname)| | ||
| | :heavy_check_mark: start_method(str) | :heavy_check_mark: IV_startmethod(fname)| | ||
| | :heavy_check_mark: abort_method() | :heavy_check_mark: IV_abort()| | ||
| | :heavy_check_mark: save_method_data(str) | :heavy_check_mark: IV_savedata(fname)| | ||
| | :heavy_check_mark: set_method_parameter(str, str) | :heavy_check_mark: IV_setmethodparameter(parname, parvalue)| | ||
| | :heavy_check_mark: get_available_data_points_number() | :heavy_check_mark: IV_Ndatapoints(value)| | ||
| | :heavy_check_mark: get_data_point(int) | :heavy_check_mark: IV_getdata(pointnr, x, y, z)| | ||
| | :heavy_check_mark: get_data_point_from_scan(int, int) | :heavy_check_mark: IV_getdatafromline(pointnr, scannr, x, y, z)| | ||
| | | :small_orange_diamond: IV_getDbFileName(fname)| | ||
| | Pyvium Methods | Core Methods | | ||
| | ------------------------------------------------------ | --------------------------------------------------------------- | | ||
| | :heavy_check_mark: open_driver() | :heavy_check_mark: IV_open() | | ||
| | :heavy_check_mark: close_driver() | :heavy_check_mark: IV_close() | | ||
| | :heavy_check_mark: get_max_device_number() | :heavy_check_mark: IV_MaxDevices() | | ||
| | :heavy_check_mark: get_active_iviumsoft_instances(int) | | | ||
| | :heavy_check_mark: select_iviumsoft_instance(int) | :heavy_check_mark: IV_selectdevice(int) | | ||
| | :heavy_check_mark: get_device_status() | :heavy_check_mark: IV_getdevicestatus() | | ||
| | :heavy_check_mark: is_iviumsoft_running() | | | ||
| | :heavy_check_mark: get_device_serial_number() | :heavy_check_mark: IV_readSN() | | ||
| | :heavy_check_mark: connect_device() | :heavy_check_mark: IV_connect(int) | | ||
| | :heavy_check_mark: disconnect_device() | :heavy_check_mark: IV_connect(int) | | ||
| | | :heavy_check_mark: IV_VersionHost(version) | | ||
| | :heavy_check_mark: get_dll_version() | :heavy_check_mark: IV_VersionDll() | | ||
| | | :heavy_check_mark: IV_VersionCheck() | | ||
| | | :heavy_check_mark: IV_HostHandle() | | ||
| | :heavy_check_mark: get_iviumsoft_version() | :heavy_check_mark: IV_VersionDllFile() | | ||
| | | :heavy_check_mark: IV_VersionDllFileStr() | | ||
| | :heavy_check_mark: select_channel(int) | :heavy_check_mark: IV_SelectChannel(int) | | ||
| | :heavy_check_mark: get_cell_status() | :heavy_check_mark: IV_getcellstatus() | | ||
| | :heavy_check_mark: set_connection_mode(int) | :heavy_check_mark: IV_setconnectionmode(int) | | ||
| | :heavy_check_mark: set_cell_on() | :heavy_check_mark: IV_setcellon(int) | | ||
| | :heavy_check_mark: set_cell_off() | | | ||
| | :heavy_check_mark: set_potential(float) | :heavy_check_mark: IV_setpotential(float) | | ||
| | :heavy_check_mark: set_we2_potential(float) | :heavy_check_mark: IV_setpotentialWE2(float) | | ||
| | :heavy_check_mark: set_curretn(float) | :heavy_check_mark: IV_setcurrent(float) | | ||
| | :heavy_check_mark: get_potential() | :heavy_check_mark: IV_getpotential() | | ||
| | :heavy_check_mark: set_current_range(int) | :heavy_check_mark: IV_setcurrentrange(int) | | ||
| | :heavy_check_mark: set_we2_current_range(int) | :heavy_check_mark: IV_setcurrentrangeWE2(int) | | ||
| | :heavy_check_mark: get_current() | :heavy_check_mark: IV_getcurrent() | | ||
| | :heavy_check_mark: get_we2_current() | :heavy_check_mark: IV_getcurrentWE2() | | ||
| | :heavy_check_mark: set_filter(int) | :heavy_check_mark: IV_setfilter(int) | | ||
| | :heavy_check_mark: set_stability(int) | :heavy_check_mark: IV_setstability(int) | | ||
| | :heavy_check_mark: set_bistat_mode(int) | :heavy_check_mark: IV_setbistatmode(int) | | ||
| | :heavy_check_mark: set_dac(int, float) | :heavy_check_mark: IV_setdac(int, float) | | ||
| | :heavy_check_mark: set_adc(int) | :heavy_check_mark: IV_getadc(int) | | ||
| | :heavy_check_mark: set_mux_channel(int) | :heavy_check_mark: IV_setmuxchannel(int) | | ||
| | | :heavy_check_mark: IV_setdigout(value) | | ||
| | | :heavy_check_mark: IV_getdigin(value) | | ||
| | :heavy_check_mark: set_ac_frequency(float) | :heavy_check_mark: IV_setfrequency(value) | | ||
| | :heavy_check_mark: set_ac_amplitude(float) | :heavy_check_mark: IV_setamplitude(value) | | ||
| | | :heavy_check_mark: IV_getcurrenttrace(npoints, rate, values) | | ||
| | | :heavy_check_mark: IV_getcurrentWE2trace(npoints, rate, values) | | ||
| | | :heavy_check_mark: IV_getpotentialtrace(npoints, rate, values) | | ||
| | | :heavy_check_mark: IV_we32setchannel(index) | | ||
| | | :heavy_check_mark: IV_we32setoffset(index, value) | | ||
| | | :heavy_check_mark: IV_we32setoffsets(nval, values) | | ||
| | | :heavy_check_mark: IV_we32getoffsets(nval, values) | | ||
| | | :heavy_check_mark: IV_we32readcurrents(values) | | ||
| | :heavy_check_mark: load_method(str) | :heavy_check_mark: IV_readmethod(fname) | | ||
| | :heavy_check_mark: save_method(str) | :heavy_check_mark: IV_savemethod(fname) | | ||
| | :heavy_check_mark: start_method(str) | :heavy_check_mark: IV_startmethod(fname) | | ||
| | :heavy_check_mark: abort_method() | :heavy_check_mark: IV_abort() | | ||
| | :heavy_check_mark: save_data(str) | :heavy_check_mark: IV_savedata(fname) | | ||
| | :heavy_check_mark: set_method_parameter(str, str) | :heavy_check_mark: IV_setmethodparameter(parname, parvalue) | | ||
| | :heavy_check_mark: get_available_data_points_number() | :heavy_check_mark: IV_Ndatapoints(value) | | ||
| | :heavy_check_mark: get_data_point(int) | :heavy_check_mark: IV_getdata(pointnr, x, y, z) | | ||
| | :heavy_check_mark: get_data_point_from_scan(int, int) | :heavy_check_mark: IV_getdatafromline(pointnr, scannr, x, y, z) | | ||
| | | :small_orange_diamond: IV_getDbFileName(fname) | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,33 @@ | ||
| ## Publishing the package | ||
|
|
||
| [using python-poetry to publish to test.pypi.org - Stack Overflow](https://stackoverflow.com/questions/68882603/using-python-poetry-to-publish-to-test-pypi-org) | ||
|
|
||
| > ## One time setup ( per host / environment) | ||
| > | ||
| > | ||
| > ### PYPI test | ||
| > | ||
| > - add repository to poetry config `poetry config repositories.test-pypi https://test.pypi.org/legacy/` | ||
| > | ||
| > - get token from [https://test.pypi.org/manage/account/token/](https://test.pypi.org/manage/account/token/) | ||
| > | ||
| > - store token using `poetry config pypi-token.test-pypi pypi-YYYYYYYY` | ||
| > | ||
| > | ||
| > | ||
| > - add repository to poetry config `poetry config repositories.test-pypi https://test.pypi.org/legacy/` | ||
| > - get token from [https://test.pypi.org/manage/account/token/](https://test.pypi.org/manage/account/token/) | ||
| > - store token using `poetry config pypi-token.test-pypi pypi-YYYYYYYY` | ||
| > | ||
| > _Note:_ 'test-pypi' is the name of the repository | ||
| > | ||
| > | ||
| > ### PYPI Production | ||
| > | ||
| > - get token from [https://pypi.org/manage/account/token/](https://pypi.org/manage/account/token/) | ||
| > - store token using `poetry config pypi-token.pypi pypi-XXXXXXXX` | ||
| > | ||
| > | ||
| > - get token from [https://pypi.org/manage/account/token/](https://pypi.org/manage/account/token/) | ||
| > - store token using `poetry config pypi-token.pypi pypi-XXXXXXXX` | ||
| > | ||
| > ## Bump version | ||
| > | ||
| > - `poetry version prerelease` | ||
| > - `poetry version patch` | ||
| > | ||
| > | ||
| > - `poetry version prerelease` | ||
| > - `poetry version patch` | ||
| > | ||
| > ## Poetry Publish | ||
| > | ||
| > | ||
| > To test | ||
| > | ||
| > - `poetry publish --build -r test-pypi` | ||
| > | ||
| > | ||
| > - `poetry publish --build -r test-pypi` | ||
| > | ||
| > To PyPi | ||
| > | ||
| > - `poetry publish --build` | ||
| > | ||
| > - `poetry publish --build` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,18 @@ | ||
| [tool.poetry] | ||
| authors = ["Alejandro Gutiérrez <[email protected]>", "Raúl Marín <[email protected]>"] | ||
| authors = [ | ||
| "Alejandro Gutiérrez <[email protected]>", | ||
| "Raúl Marín <[email protected]>", | ||
| ] | ||
| description = "A tiny Python wrapper around the <Software development driver DLL> for IviumSoft." | ||
| exclude = ["docs", "tests"] | ||
| homepage = "https://github.com/SF-Tec/pyvium" | ||
| keywords = ["ivium", "iviumsoft", "ivium software", "ivium compactstat"] | ||
| repository = "https://github.com/SF-Tec/pyvium" | ||
| license = "Apache-2.0" | ||
| name = "pyvium" | ||
| packages = [{include = "pyvium"}] | ||
| packages = [{ include = "pyvium" }] | ||
| readme = "README.md" | ||
| version = "0.1.2beta" | ||
| version = "0.1.3beta" | ||
| classifiers = [ | ||
| # How mature is this project? Common values are | ||
| # 3 - Alpha | ||
|
|
@@ -26,7 +29,7 @@ classifiers = [ | |
| # Specify the Python versions you support here. In particular, ensure | ||
| # that you indicate whether you support Python 2, Python 3 or both. | ||
| 'Programming Language :: Python :: 2', | ||
| 'Programming Language :: Python :: 3' | ||
| 'Programming Language :: Python :: 3', | ||
| ] | ||
|
|
||
| [tool.poetry.dependencies] | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.