diff --git a/.ci_support/environment.yml b/.ci_support/environment.yml new file mode 100644 index 0000000000000000000000000000000000000000..815a1cf445dde3770d5e47fce8498ec1aecf9275 --- /dev/null +++ b/.ci_support/environment.yml @@ -0,0 +1,19 @@ +channels: + - conda-forge +dependencies: + - cython + - libsass + - jupytext + - sphinx =2.4.4 + - pybtex + - jupyter_sphinx + - sphinxcontrib-bibtex + - markdown-it-py + - myst-parser + - nest-asyncio + - async_generator + - nbclient + - nbdime + - sphinx-copybutton + - pydata-sphinx-theme + - matplotlib =3.2.1 diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000000000000000000000000000000000000..d64819040c47fa46fc659b29d1c698cb085c82d7 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,33 @@ +name: Deploy + +on: + push: + branches: [ master ] + +jobs: + build: + + runs-on: ubuntu-latest + env: + CONDA_PREFIX: /usr/share/miniconda/ + + steps: + - uses: actions/checkout@v2 + - uses: conda-incubator/setup-miniconda@v2 + with: + auto-update-conda: true + python-version: 3.8 + environment-file: .ci_support/environment.yml + auto-activate-base: false + - run: rm README.md CODE_OF_CONDUCT.md + - run: pip install git+https://github.com/ExecutableBookProject/jupyter-book + - run: jupyter-book build . --path-output public + - run: mv public/_build/html public_html + - run: touch public_html/.nojekyll + - name: Deploy 🚀 + uses: JamesIves/github-pages-deploy-action@3.7.1 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH: gh-pages # The branch the action should deploy to. + FOLDER: public_html # The folder the action should deploy. + CLEAN: true diff --git a/.github/workflows/notebooks.yml b/.github/workflows/notebooks.yml index f70ae36a647b74905bf63e7474a50c0d133e9497..e37ff85b6ce5a25c67a5fbb37c46d8919c6e103a 100644 --- a/.github/workflows/notebooks.yml +++ b/.github/workflows/notebooks.yml @@ -19,7 +19,7 @@ jobs: - uses: conda-incubator/setup-miniconda@v2 with: auto-update-conda: true - python-version: 3.7 + python-version: 3.8 environment-file: binder/environment.yml auto-activate-base: false - name: Tests diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000000000000000000000000000000000000..a97ee9510ed6a31f00e121f62d3ea2a7f821eabf --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,27 @@ +name: Tests + +on: + pull_request: + branches: [ master ] + +jobs: + build: + + runs-on: ubuntu-latest + env: + CONDA_PREFIX: /usr/share/miniconda/ + GPAW_SETUP_PATH: /usr/share/miniconda/share/gpaw + + steps: + - uses: actions/checkout@v2 + - uses: conda-incubator/setup-miniconda@v2 + with: + auto-update-conda: true + python-version: 3.8 + environment-file: .ci_support/environment.yml + auto-activate-base: false + - run: rm README.md CODE_OF_CONDUCT.md + - run: pip install git+https://github.com/ExecutableBookProject/jupyter-book + - run: jupyter-book build . --path-output public + - run: mv public/_build/html public_html + - run: touch public_html/.nojekyll diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000000000000000000000000000000000..92b4451675ac9259dab163cc09e64a96dd798338 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at pyiron@mpie.de. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..2f17b4975332a6d1443b734b05c37322d9292fe6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) 2020, Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +* Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000000000000000000000000000000000000..4764ae25dd9bde93ae9d1bac1dba26be0a14831c --- /dev/null +++ b/_config.yml @@ -0,0 +1,17 @@ +title: Software Tools from Atomistics to Phase Diagrams +author: Jan Janssen +logo: images/logo_dark.png + +execute: + execute_notebooks : off + +html: + extra_navbar : Powered by <a href="https://pyiron.org">pyiron</a> + +repository: + url : https://github.com/pyiron/potentials-workshop-2021 + path_to_book : "" + +launch_buttons: + notebook_interface : jupyterlab + binderhub_url : https://mybinder.org diff --git a/_toc.yml b/_toc.yml new file mode 100644 index 0000000000000000000000000000000000000000..2e622e28a901e63b53393ba01893301f5e352b42 --- /dev/null +++ b/_toc.yml @@ -0,0 +1,8 @@ +- file: README.md +- file: day_1/ex_01_introduction_to_pyiron.ipynb +- file: day_1/ex_02_creating_structure_databases.ipynb +- file: day_2/00-IntroductionDay2.ipynb +- file: day_2/01-atomicrex/WorkshopPotentialEAM.ipynb +- file: day_2/02-runner/Workflow-RuNNer.ipynb +- file: day_2/03-ace/pacemaker-fit-tutorial.ipynb +- file: day_3/ex_01_validation.ipynb \ No newline at end of file diff --git a/images/logo_dark.png b/images/logo_dark.png new file mode 100644 index 0000000000000000000000000000000000000000..a601086e5383ad7bc0f903191f2918ce1022d9c2 Binary files /dev/null and b/images/logo_dark.png differ