Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #4

Merged
merged 4 commits into from
Nov 3, 2023
Merged

Update README.md #4

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e05ab69
Update README.md
samwaseda Nov 1, 2023
82356e5
Update README.md
samwaseda Nov 2, 2023
ddc6efa
Update README.md
samwaseda Nov 2, 2023
3bd5d5e
resolve conflict
samwaseda Nov 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,25 @@ This code allows you to launch Metropolis Monte Carlo simulations via Heisenberg

## How to compile

Download all files and run `python setup.py build_ext --inplace`.
`mamonca` can be installed directly from conda:

```
conda install -c conda-forge mamonca
```
In order to use build it from the repository, run
```
git clone https://github.com/samwaseda/mamonca
cd mamonca
python setup.py build_ext --user
```

## First steps:

In the following simple (but complete) example, we create a bcc Fe system using [pyiron](http://github.com/pyiron/pyiron) and launch a Metropolis Monte Carlo simulation with a Heisenberg coefficient `J=0.1` (eV) for the first nearest neighbor pairs:

```python
from pyiron import Project
from mc import MC
from pyiron_atomistics import Project
from mamonca import MC

structure = Project('.').create.structure.bulk(
name='Fe',
Expand Down
Loading