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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyiron_base-0.6.17.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.17.tar.gz
Algorithm Hash digest
SHA256 815fecebd3dcfca90de10f10c0fe9ee279d32df2e2c2467555b4d7c170b88871
MD5 df8af045032b0420d987e6d45a7dcd30
BLAKE2b-256 23931a55c3f825e101b47f05dc4389c4ed65ad66c1fd92b523d5821abe14b4f2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyiron_base-0.6.17-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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 76538d84f1082bda38d68efcaf38cb1e79a1729ddc2088b388a7176f6b7d4420
MD5 a39c58b5cdaa33c127a6975c84efd9cd
BLAKE2b-256 edd8c7742e57d52e19bea61c26583162c447faed1148b543748a16b1679b7213

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