About oommf-feedstock

Feedstock license: BSD-3-Clause

Package license: Custom

Summary: Object Oriented MicroMagnetic Framework (OOMMF)

Development: https://github.com/fangohr/oommf

Documentation: http://math.nist.gov/oommf/doc/

The Object Oriented MicroMagnetic Framework (OOMMF) forms a completely functional micromagnetics package. OOMMF is written in C++. For portable user interfaces, it uses Tcl/Tk so that OOMMF operates across a wide range of Unix, Windows, and MacOS platforms.

The recipe for building this OOMMF conda package was developed by Martin Lang, Thomas Kluyver, Ryan A. Pepper, Marijan Beg, and Hans Fangohr at the University of Southampton, Max Planck Institute for the Structure and Dynamics of Matter, European XFEL, and Imperial College London as a part of OpenDreamKit – Horizon 2020 European Research Infrastructure project (676541) and EPSRC Programme Grant on Skyrmionics (EP/N032128/1).

This package contains Dzyaloshinskii-Moriya extensions for Cnv, T(O), and D2d crystallographic classes as well as magneto-elastic energy term. These extensions are not included in the OOMMF binaries and tarballs provided by NIST. More information can be found at https://github.com/fangohr/oommf.

Current build status

Azure

Variant	Status
linux_64
osx_64
win_64

Current release info

Name	Downloads	Version	Platforms

Installing oommf

Installing oommf from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, oommf can be installed with conda:

conda install oommf

or with mamba:

mamba install oommf

It is possible to list all of the versions of oommf available on your platform with conda:

conda search oommf --channel conda-forge

or with mamba:

mamba search oommf --channel conda-forge

Alternatively, mamba repoquery may provide more information:

# Search all versions available on your platform:
mamba repoquery search oommf --channel conda-forge

# List packages depending on `oommf`:
mamba repoquery whoneeds oommf --channel conda-forge

# List dependencies of `oommf`:
mamba repoquery depends oommf --channel conda-forge

About conda-forge

conda-forge is a community-led conda channel of installable packages. In order to provide high-quality builds, the process has been automated into the conda-forge GitHub organization. The conda-forge organization contains one repository for each of the installable packages. Such a repository is known as a feedstock.

A feedstock is made up of a conda recipe (the instructions on what and how to build the package) and the necessary configurations for automatic building using freely available continuous integration services. Thanks to the awesome service provided by Azure, GitHub, CircleCI, AppVeyor, Drone, and TravisCI it is possible to build and upload installable packages to the conda-forge Anaconda-Cloud channel for Linux, Windows and OSX respectively.

To manage the continuous integration and simplify feedstock maintenance conda-smithy has been developed. Using the conda-forge.yml within this repository, it is possible to re-render all of this feedstock's supporting files (e.g. the CI configuration files) with conda smithy rerender.

For more information please check the conda-forge documentation.

Terminology

feedstock - the conda recipe (raw material), supporting scripts and CI configuration.

conda-smithy - the tool which helps orchestrate the feedstock. Its primary use is in the construction of the CI .yml files and simplify the management of many feedstocks.

conda-forge - the place where the feedstock and smithy live and work to produce the finished article (built conda distributions)

Updating oommf-feedstock

If you would like to improve the oommf recipe or build a new package version, please fork this repository and submit a PR. Upon submission, your changes will be run on the appropriate platforms to give the reviewer an opportunity to confirm that the changes result in a successful build. Once merged, the recipe will be re-built and uploaded automatically to the conda-forge channel, whereupon the built conda packages will be available for everybody to install and use from the conda-forge channel. Note that all branches in the conda-forge/oommf-feedstock are immediately built and any created packages are uploaded, so PRs should be based on branches in forks and branches in the main repository should only be used to build distinct package versions.

In order to produce a uniquely identifiable distribution:

If the version of a package is not being increased, please add or increase the build/number.
If the version of a package is being increased, please remember to return the build/number back to 0.

conda-forge/oommf-feedstock