Skip to main content

Highly configurable 2D (SVG) & 3D (threejs) visualisations for ASE/Pymatgen structures, within the Jupyter Notebook

Project description

ase-notebook

CI Status Coverage CircleCI Code style: black RTD PyPI Conda

A highly configurable 2D (SVG) & 3D (threejs) visualisation creator for ASE/Pymatgen structures, within the Jupyter Notebook.

Example SVG

Purpose

To create atomic configuration visualisations, principally within a Jupyter Notebook.

Contributing

Contributions are very welcome.

The following will discover and run all unit test:

>> pip install -e .[testing]
>> pytest -v

Coding Style Requirements

The code style is tested using flake8, with the configuration set in .flake8, and code should be formatted with black.

Installing with ase-notebook[code_style] makes the pre-commit package available, which will ensure these tests are passed by reformatting the code and testing for lint errors before submitting a commit. It can be setup by:

>> cd ase-notebook
>> pre-commit install

Optionally you can run black and flake8 separately:

>> black .
>> flake8 .

Editors like VS Code also have automatic code reformat utilities, which can adhere to this standard.

License

See LICENSE file

Issues

If you encounter any problems, please file an issue along with a detailed description.

Project details


Download files

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

Files for ase-notebook, version 0.3.2
Filename, size File type Python version Upload date Hashes
Filename, size ase_notebook-0.3.2-py3-none-any.whl (52.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size ase-notebook-0.3.2.tar.gz (48.8 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page