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.22.tar.gz (222.1 kB view details)

Uploaded Source

Built Distribution

pyiron_base-0.6.22-py3-none-any.whl (278.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyiron_base-0.6.22.tar.gz
  • Upload date:
  • Size: 222.1 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.22.tar.gz
Algorithm Hash digest
SHA256 67f7ab4ab59f1e18f8f14e3b284f5bf222c755b311d89c13accb562bbdc68989
MD5 86bab7a15c26e372de49b9da8e80bd00
BLAKE2b-256 aaf7758fcb7f90fa45d4636c132f2e5bc569a5ac3f14fade8ef6f0591f04a652

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyiron_base-0.6.22-py3-none-any.whl
  • Upload date:
  • Size: 278.8 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.22-py3-none-any.whl
Algorithm Hash digest
SHA256 e272f336368c2d056fc58ec09bd4b32f8f7d89dd1c4cfd087692a4f3d79236fa
MD5 097dc2bb94ca1a13f53d40dca1ed153b
BLAKE2b-256 5cf4b6ee613891d328fad4e00b34d072ba3de9e8a30d377409daee52de38dd1b

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