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

Uploaded Source

Built Distribution

pyiron_base-0.6.10-py3-none-any.whl (272.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyiron_base-0.6.10.tar.gz
Algorithm Hash digest
SHA256 b35c7804336ea8c90cef75f27fe9d2c8e2bcdb94461e89d6e7bd27d328c48e8f
MD5 f3dcaebd929af75321f5f0d9835cd702
BLAKE2b-256 5ab2fec398b6b08594cfb07b3b5a248389aeec04bd576bf317b4407e2f553903

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for pyiron_base-0.6.10-py3-none-any.whl
Algorithm Hash digest
SHA256 f278827d82a5aa8227dc9f3dca07c2d64f27821bdb2f63f9cc8b9731dcd7ebb2
MD5 03de294859c9c4db462c3f9d72fffe36
BLAKE2b-256 88d2e7b40f4c2c9e1d3df8e12ecd7e581ead5c982f251504ed1cbae0e71d5913

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