Skip to content

Commit

Permalink
typos in readme, more on installation and contact field
Browse files Browse the repository at this point in the history
  • Loading branch information
bonfus committed Mar 29, 2017
1 parent 9ebd3ed commit 6682228
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Known problems
- OpenMP implementation is EXPERIMENTAL (passes tests but needs more work)


Please not that the code is still under heavy development.
Please note that the code is still under heavy development.
You'll probably find bugs so please report them!

Authors
Expand Down
34 changes: 34 additions & 0 deletions docs/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,37 @@ You can also use pip ::
pip install muesr-0.1.tar.gz

(you'll probably need to be superuser)

Installation in virtualenv
--------------------------

Virtualenv offers a simple way of virtualizing the Python environment.
This means that you can have a separate collection of python packages
for running Muesr (and install Muesr itself) without affecting the Python
installation system-wide.

To install Muesr in a virtualenv, first make sure that the command `virtualenv`
is available on your system. If not, please check online what is the
recommended way of installing virtualenv in your os.

To create the virualenv run in a terminal:

virtualenv muesr-env

and to activate the environment (linux and OsX)

cd muesr-env
source bin/activate

now you can install Muesr in the virtualenv with the command

pip install https://github.com/bonfus/muesr/archive/master.tar.gz

this will only provide the minimal dependencies. To have access to all
Muesr functions you also need `spglib` and `PyYAML`

pip install pyyaml spglib

Now you are ready to go! Why not start with Muesr examples?


10 changes: 8 additions & 2 deletions docs/Tutorial.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ with the following command ::

>>> from muesr.engines.clfc import locfield

A detailed description of the possible calculatros is given in the
A detailed description of the possible calculators is given in the
:py:func:`~muesr.engines.clfc.locfield` documentation.

Let's go straight to the local field evaluation which is obtained by
Expand Down Expand Up @@ -230,7 +230,13 @@ In the next tutorial we will discuss the Hyperfine Contact Field.
The Contact field contribution
------------------------------

TODO
In muesr, the current implementation of the contact field only allows a
scalar interaction between a set of nearest neighbouring magnetic atoms
and the muon. This is generally insufficient to describe the contact
hypefine field but it can be a reasobale approximation in ferromagnets.

TODO: discuss the details.




Expand Down

0 comments on commit 6682228

Please sign in to comment.