Skip to main content

A collection of Django apps defining data models for managing chemical species, reactions and datasets.

Project description

Django-Valem is a collection of Django apps defining data models for parsing, validation, manipulation and interpretation of chemical reactions, formulas, and quantum states. The django-valem apps package is based around PyValem.

Installation:

The django-valem apps can be installed either from PyPI using pip

python3 -m pip install django-valem

or from the source by running from the project source directory

python3 -m pip install .

Configuration:

The django-valem apps can be added to any Django project by adding the following apps into the INSTALLED_APPS list in the settings.py of the project:

INSTALLED_APPS = [
    ...

    "rp",  # App handling species and their states
    "rxn",  # App handling chemical reactions between species (rp.RP instances)
    "ds",  # App handling datasets attached to rxn.Reaction instances
    "refs",  # App handling references for ds.ReactionDataSet subclasses instances
]

For Developers:

It goes without saying that any development should be done in a clean virtual environment. After cloning or forking the project from its GitHub page, django-valem might be installed into the virtual environment in editable mode with

pip install -e .[dev]

or on zsh:

pip install -e .'[dev]'

The [dev] extra installs (apart from the package dependencies) also several development-related packages, such as black, ipython, or django itself. The tests can then be executed by running (from the project root directory)

python runtests.py

The project does not have requirements.txt by design, all the package dependencies are rather handled by setup.py. The package needs to be installed to run the tests, which grants the testing process another layer of usefulness.

The project code is formatted by black. Always make sure to format your code before submitting a pull request, by running black on all your python files, or black . from the project source directory.

If the rp.models.py, or rxn.models.py are changed, the makemigrations.py script needs to be run to make migrations for the apps, before the apps are pushed to master, or published to PyPI.

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

django-valem-0.1.14.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

django_valem-0.1.14-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file django-valem-0.1.14.tar.gz.

File metadata

  • Download URL: django-valem-0.1.14.tar.gz
  • Upload date:
  • Size: 18.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for django-valem-0.1.14.tar.gz
Algorithm Hash digest
SHA256 4f0c1acaa3f721020dc723b201bbe97285cc3bf44211d8b77295c447998ab655
MD5 a7601ff1167af397bf3bf92a2e1f3b30
BLAKE2b-256 964368b64d4933d8c7ba96efb89a237d50d414f1f14e9d5550c6eea9b14a06a5

See more details on using hashes here.

File details

Details for the file django_valem-0.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for django_valem-0.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 451c7ea3ffbc3316506c1ac9a55be8a9b3b06672047422118bace7007ac82527
MD5 9a48b29e35198e24aeee43f48db6fa8b
BLAKE2b-256 5dfc091be46e21a12692fd14c273344085eab7148fee59509df407597c860dd2

See more details on using hashes here.

Supported by

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