Compare commits
2 Commits
Author | SHA1 | Date | |
---|---|---|---|
06b4c4f870 | |||
a2f61f7405 |
17
README.md
17
README.md
@ -2,7 +2,7 @@
|
||||
[](https://img.shields.io/github/license/RecordEvolution/IMCtermite)
|
||||
[](https://img.shields.io/github/stars/RecordEvolution/IMCtermite)
|
||||

|
||||
[](https://pypi.org/project/IMCtermite/)
|
||||
[](https://pypi.org/project/imctermite/)
|
||||
|
||||
# IMCtermite
|
||||
|
||||
@ -131,24 +131,21 @@ which may require root permissions.
|
||||
|
||||
### Python
|
||||
|
||||
To integrate the library into a customized ETL toolchain, several cython targets
|
||||
To integrate the library into a customized ETL toolchain, several python targets
|
||||
are available. For a local build that enables you to run the examples, use:
|
||||
|
||||
```
|
||||
make cython-build
|
||||
make python-build
|
||||
```
|
||||
|
||||
However, in a production environment, a proper installation of the module with
|
||||
`make cython-install` is recommended for system-wide availability of the module.
|
||||
|
||||
#### Installation with pip
|
||||
|
||||
The package is also available in the [Python Package Index](https://pypi.org)
|
||||
at [IMCtermite](https://pypi.org/project/IMCtermite/).
|
||||
at [imctermite](https://pypi.org/project/imctermite/).
|
||||
To install the latest version simply do
|
||||
|
||||
```Shell
|
||||
python3 -m pip install IMCtermite
|
||||
python3 -m pip install imctermite
|
||||
```
|
||||
|
||||
which provides binary wheels for multiple architectures on _Windows_ and _Linux_
|
||||
@ -195,9 +192,9 @@ Given the `IMCtermite` module is available, we can import it and declare an inst
|
||||
of it by passing a _raw_ file to the constructor:
|
||||
|
||||
```Python
|
||||
import IMCtermite
|
||||
import imctermite
|
||||
|
||||
imcraw = IMCtermite.imctermite(b"sample/sampleA.raw")
|
||||
imcraw = imctermite.imctermite(b"sample/sampleA.raw")
|
||||
```
|
||||
|
||||
An example of how to create an instance and obtain the list of channels is:
|
||||
|
Loading…
x
Reference in New Issue
Block a user