Skip to main content

No project description provided

Project description

PyPI - Version Downloads monthly Downloads total GitHub Workflow Status Documentation Status Contributions https://img.shields.io/badge/code%20style-black-000000.svg https://img.shields.io/badge/license-MIT-blue.svg
Noctis Logo

What is NOCTIS?

NOCTIS is a Python package for modeling and analyzing chemical reaction data as graph structures.

It allows you to build and explore complex reaction networks — beyond just molecules and chemical equations — by supporting additional node types, metadata, and relationships.

NOCTIS provides tools to:

  • Preprocess and validate chemical reaction datasets

  • Build graph representations from reaction data

  • Query and navigate reaction networks

  • Mine synthesis routes using a custom Java plugin

  • Interact programmatically with graph databases

  • Transform query results into formats suitable for further analysis (e.g., NetworkX, Pandas)

To learn more, visit the documentation.

Try it interactively with our example notebook! 📓 Example Notebook

Installation

Create a dedicated Python environment for this package with your favorite environment manager.

conda create -n noctis python=3.9
conda activate noctis
  • Option 1: Install the package from the GitHub repository:

pip install git+ssh://git@github.com/syngenta/noctis.git@main
  • Option 2: Install the package from the Python Package Index (PyPI):

pip install noctis

Configuration

Both NOCTIS and its companion package Linchemin need a small on-disk configuration before you can use them.

After installation, and before the first usage, run the following command:

noctis_configure && linchemin_configure

What each command does

noctis_configure
Creates the directory ~/noctis/ and writes three files
settings.yaml – default runtime settings (edit as needed)
.secrets.yaml – placeholders for credentials (replace with the real values)
schema.yaml – description of the graph schema used by the database
linchemin_configure
Creates the directory ~/linchemin/ and writes two files
settings.toml – default settings you may tweak
.secrets.toml – placeholders for the required secrets

For more details:

🔧 NOCTIS – see the Configuration chapter of this documentation.
🔧 Linchemin – see the Linchemin repo for full details.


⚠️ ALERT ⚠️:
If you skip this step you’ll run straight into mysterious import errors (e.g. “Settings object has no attribute ‘CONSTRUCTORS’”). The fix is simply to run the two commands above once.

Development Installation

If you’re working on the development of NOCTIS and want to run directly from source:

git clone git@gitlab.com:syngentagroup/scientific-computing-team/noctis.git
pip install -e noctis/[dev]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

noctis-1.0.2.tar.gz (44.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

noctis-1.0.2-py3-none-any.whl (50.4 kB view details)

Uploaded Python 3

File details

Details for the file noctis-1.0.2.tar.gz.

File metadata

  • Download URL: noctis-1.0.2.tar.gz
  • Upload date:
  • Size: 44.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for noctis-1.0.2.tar.gz
Algorithm Hash digest
SHA256 f109701c849cb37a3610a6bc093e3bac424730583df54b1ec0a3d962bda0d96d
MD5 440e069a0f9d3355175f01d229a43b3e
BLAKE2b-256 132e6ad4fb86cd0e48d4b9ae720d531f820fdfb949ee7d9f7189724171f82370

See more details on using hashes here.

File details

Details for the file noctis-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: noctis-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 50.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.11

File hashes

Hashes for noctis-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1e6ab8273ab69fb0fe4a66913b58a8d47c1476dbee1cf108fa3c1e963f0a38ee
MD5 f71e2a5510032f63a8806439670349ef
BLAKE2b-256 b4df4c970b99ffec09a509a41cb2f64e791138f70b947392959990b3b68b1dd5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page