Skip to main content

Core components of the pyiron integrated development environment (IDE) for computational materials science

Project description

Coverage Status Release_Date Build Status Downloads Documentation Status

pyiron - an integrated development environment (IDE) for computational materials science. While the general pyiron framework is focused on atomistic simulations, pyiron_base is independent of atomistic simulation. It can be used as a standalone workflow management combining a hierachical storage interface based on HDF5, support for HPC computing clusters and a user interface integrated in the Jupyter environment.

Installation

You can test pyiron on Mybinder.org (beta). For a local installation we recommend to install pyiron inside an anaconda environment:

conda install -c conda-forge pyiron_base

See the Documentation-Installation page for more details.

Example

After the successful configuration you can start your first pyiron calculation. Navigate to the the projects directory and start a jupyter notebook or jupyter lab session correspondingly:

cd ~/pyiron/projects
jupyter notebook

Open a new jupyter notebook and inside the notebook you can now validate your pyiron calculation by creating a test project:

from pyiron import Project
pr = Project('test')
pr.path

Getting started:

Test pyiron with mybinder:

mybinder

License and Acknowledgments

pyiron_base is licensed under the BSD license.

If you use pyiron in your scientific work, please consider citing

@article{pyiron-paper,
  title = {pyiron: An integrated development environment for computational materials science},
  journal = {Computational Materials Science},
  volume = {163},
  pages = {24 - 36},
  year = {2019},
  issn = {0927-0256},
  doi = {https://doi.org/10.1016/j.commatsci.2018.07.043},
  url = {http://www.sciencedirect.com/science/article/pii/S0927025618304786},
  author = {Jan Janssen and Sudarsan Surendralal and Yury Lysogorskiy and Mira Todorova and Tilmann Hickel and Ralf Drautz and Jörg Neugebauer},
  keywords = {Modelling workflow, Integrated development environment, Complex simulation protocols},
}

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

pyiron_base-0.6.14.tar.gz (222.2 kB view details)

Uploaded Source

Built Distribution

pyiron_base-0.6.14-py3-none-any.whl (277.9 kB view details)

Uploaded Python 3

File details

Details for the file pyiron_base-0.6.14.tar.gz.

File metadata

  • Download URL: pyiron_base-0.6.14.tar.gz
  • Upload date:
  • Size: 222.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for pyiron_base-0.6.14.tar.gz
Algorithm Hash digest
SHA256 d1e26e1ffc49a1d085e19abda380de84e0f4ef35cbae04cfa8122707a6ab9f44
MD5 6269d9a5bb9f97b88ac39fba03c56bea
BLAKE2b-256 0ba8db0125320f0e81de4e6ffd939393b2d03bd1b964b50944e59573a8c87f27

See more details on using hashes here.

File details

Details for the file pyiron_base-0.6.14-py3-none-any.whl.

File metadata

  • Download URL: pyiron_base-0.6.14-py3-none-any.whl
  • Upload date:
  • Size: 277.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for pyiron_base-0.6.14-py3-none-any.whl
Algorithm Hash digest
SHA256 06db85937220d3a015b126fda09805a07769981aecf80901eedf6ca72e91f012
MD5 8cd6f75abf4f151531524664b11bfec1
BLAKE2b-256 2f59749af144259602de47ce3c2c796fdb9bfbac209c582255ad11857070d567

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