What is an iModulon?
To learn about iModulons, how they are computed, and what they can tell you, see our about page.
Installation
With Docker
The easiest way to get started with PyModulon is using the Docker container.
Install Docker
Open terminal and navigate to your work folder
Run the following commands to start a Jupyter Notebook server:
docker run -p 8888:8888 -v "${PWD}":/home/jovyan/work sbrg/pymodulonCopy the URL from terminal to connect to the Jupyter notebook
Navigate to the work folder, which has your current directory mounted.
To close the notebook, press Ctrl+C in terminal. All changes made to files in your current directory are saved to your local machine.
With Pip
You can install PyModulon from PyPI using pip as follows:
python -m pip install pymodulon
With Conda
Alternatively, you can install using Conda:
conda install -c conda-forge pymodulon
We recommend installing through a conda environment:
conda create -n pymodulon -c conda-forge pymodulon conda activate pymodulon
Optional Dependencies
Some features of PyModulon require additional dependencies. Follow the links below for installation instructions.
This step is not necessary if you use the Docker container.
Documentation
The documentation for PyModulon can be found here.
Development
If you would like to assist in development, please install pre-commit to ensure code style and consistency.
We recommend using an editable pip installation for development:
git clone https://github.com/SBRG/pymodulon.git cd pymodulon python -m pip install -e .
This method of installation will automatically update your package each time you pull from this repository.
To update your code, run the following from your local PyModulon folder:
git pull
Cite
Please cite the original E. coli iModulon paper: Sastry et al. Nature Communications. 2019.
If you use organism-specific datasets in your work, please cite these datasets:
Escherichia coli: Sastry et al. Nature Communications. 2019.
Bacillus subtilis: Rychel et al. Nature Communications. 2020.
Staphylococcus aureus: Poudel et al. PNAS. 2020.
2 maintainers
Metadata
2 maintainers
Release files for pymodulon 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pymodulon-0.2.1.tar.gz | 55.7 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pymodulon-0.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 105.9 MB
Release files / pymodulon-0.2.1.tar.gz
| Download URL | pymodulon-0.2.1.tar.gz |
|---|---|
| Size | 55.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7984649cdf25a9d57a59000ac0adc781f44b79eaafd13a4a3f61c87ab3878d06
|
|
BLAKE2b-256 checksum How to use checksums |
1b21e338d9b9487ff7456cc595d8fdf931b63d915db276ecf56165bf0c432462
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5
|
Release files / pymodulon-0.2.1-py3-none-any.whl
| Download URL | pymodulon-0.2.1-py3-none-any.whl |
|---|---|
| Size | 50.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
24cf88b53e7dfe69c3bc1d4f3e28b2d30a0bf874eab1930d22208aff3ddd81b8
|
|
BLAKE2b-256 checksum How to use checksums |
6342302a03ea9289cf6fdff0367c85ea7809d52e9f235e904fe453a2d7672176
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.5
|
