Initial commit.

LICENSE

@@ -0,0 +1,11 @@
+Copyright <2019> Micromagnetics community.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. 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.
+
+3. 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.

README.md

@@ -0,0 +1,60 @@
+# Reproducible micromagetics example
+Marijan Beg<sup>1,2</sup> and Hans Fangohr<sup>1,2</sup>
+
+<sup>1</sup> *European XFEL GmbH, Holzkoppel 4, 22869 Schenefeld, Germany*  
+<sup>2</sup> *Faculty of Engineering and the Environment, University of Southampton, Southampton SO17 1BJ, United Kingdom*  
+
+| Description | Badge |
+| --- | --- |
+| Binder | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/reproducible-micromagnetics/example/master?filepath=index.ipynb) |
+| License | [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) |
+
+## About
+
+Reproducible micromagnetics is an organisation where:
+
+- Jupyter notebooks, reproducing results from different publications, can be hosted 
+
+- All notebooks hosted in this organisation can be run in the cloud and the results reproduced by anybody
+
+## How to use this repository
+
+In order to use this repository as a template for reproducing the results from a publication, please follow the following steps:
+
+1. Please clone this repository
+2. Add the Ubermag notebooks to the `ipynb/` directory
+3. Change the list of notebooks in `ipynb/index.ipynb`
+4. If your notebooks require any other packages to be installed, which are not part of Ubermag, please add them to `environment.yml`. In order to make sure your work is reproducible in the future, please fix the package versions in `environment.yml`.
+5. Change the LICENSE file if required
+6. Push to a new GitHub repository and modify the URLs in `README.md`
+7. Change the `README.md` file
+
+## Reproducibility guidelines
+
+There are several guidelines to keep in mind when publising your data/computing scripts:
+
+1. The repository should contain all the data and computing scripts as well as the data analysis and visualisation code. Ideally, notebooks should reproduce all images in the publication.
+2. In order to make sure that the notebooks can be run in the future, the versions of packages should be specified in `environment.yml`.
+3. Very often papers deal with large simulations or they explore large parameter spaces. This makes them difficult to reproduce, because the simulation time is too long for them to be run in the cloud and inside Jupyter notebook. The recommendation in this case is to have a reproducibility script which provides a minimalistic example or a simulation at one parameter space point.
+
+## Binder
+
+Jupyter notebooks hosted in this repository can be used in the cloud via Binder. This does not require you to have anything installed and no files will be created on your machine. To access Binder, use this [link](https://mybinder.org/v2/gh/reproducible-micromagnetics/example/master?filepath=index.ipynb).
+
+## Support
+
+If you require support or have any questions, you are welcome to raise an issue in our [ubermag/help](https://github.com/ubermag/help) repository.
+
+## License
+
+Licensed under the BSD 3-Clause "New" or "Revised" License. For details, please refer to the [LICENSE](LICENSE) file.
+
+## How to cite
+
+Please cite it as:
+
+1. Add your paper here
+
+## Acknowledgements
+
+Developed as a part of [OpenDreamKit](http://opendreamkit.org/) – Horizon 2020 European Research Infrastructure project (676541). Add another grants here if necessary.

environment.yml

@@ -0,0 +1,6 @@
+name: ubermag-environment
+channels:
+  - conda-forge
+dependencies:
+  - python=3.6
+  - oommfc

index.ipynb

@@ -0,0 +1,36 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Paper: Example\n",
+    "\n",
+    "The following Jupyter notebooks are available:\n",
+    "\n",
+    "- [Stable and manipulable Bloch point](stable-and-manipulable-bloch-point.ipynb)"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.7.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}