Skip to content

Commit a2b79f8

Browse files
committed
minor updates to docs
1 parent 9152097 commit a2b79f8

File tree

3 files changed

+37
-36
lines changed

3 files changed

+37
-36
lines changed

Readme.md

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Authors (as of 2015, listed alphabetically by first name):
3232
* Python 3.6+
3333
* Python modules:
3434
NumPy, SciPy, SymPy, Matplotlib
35-
35+
3636
## Optional, needed for some functionality
3737

3838
* pycddlib
@@ -43,14 +43,14 @@ Authors (as of 2015, listed alphabetically by first name):
4343
1. Clone this repository using git (or download it). To install git, open a terminal window and type
4444

4545
`sudo apt-get install git`
46-
47-
Then go to the directory into which you want to clone the repository, and type
48-
46+
47+
Then go to the directory into which you want to clone the repository, and type
48+
4949
`git clone https://github.com/geodynamics/burnman.git`
50-
50+
5151
Alternatively, if you don't want to use git, you can download the current master branch from https://github.com/geodynamics/burnman/archive/master.zip.
5252
2. Install using apt by opening a terminal window and entering
53-
`sudo apt-get install python python-scipy python-numpy python-sympy python-matplotlib`
53+
`sudo apt-get install python python-scipy python-numpy python-sympy python-matplotlib`
5454
3. Go to the Burnman examples directory and type:
5555
```python example_beginner.py```
5656
Figures should show up, indicating that it is working.
@@ -61,21 +61,21 @@ Figures should show up, indicating that it is working.
6161
1. Clone this repository using git (or download it). To install git, open a terminal window and type
6262

6363
`ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
64-
64+
6565
`brew doctor`
66-
66+
6767
`brew install git`
68-
69-
Then go to the directory into which you want to clone the repository, and type
70-
68+
69+
Then go to the directory into which you want to clone the repository, and type
70+
7171
`git clone https://github.com/geodynamics/burnman.git`
72-
72+
7373
Alternatively, if you don't want to use git, you can download the current master branch from https://github.com/geodynamics/burnman/archive/master.zip.
7474
2. get Xcode
7575
3. If you don't have Python yet, download it (for free) from
76-
python.org/download . Make sure to use either Python 2.7 or Python 3.4+.
76+
python.org/download . Make sure to use a modern version of Python (3.6+).
7777
To check your version of python, type the following in a
78-
terminal:
78+
terminal:
7979
python --version
8080
4. Install the latest Numpy version: http://sourceforge.net/projects/numpy/files/NumPy/
8181
5. Install the latest Scipy at http://sourceforge.net/projects/scipy/files/
@@ -95,21 +95,23 @@ Problems you might run into:
9595
matching architecture in universal wrapper`. You can check if your python
9696
distribution is 32 or 64 bit with the following lines:
9797
```
98-
python
98+
python
9999
>>> import platform
100100
>>> print platform.architecture()
101101
```
102102

103103
## Install under Windows
104104

105105
1. Clone this repository using git (or download it). git can be downloaded from here: https://gitforwindows.org/. There are a number of different ways to use git as installed under windows (command-line, gui). Use your favoured method to clone the burnman repository: https://github.com/geodynamics/burnman.git. Alternatively, if you don't want to use git, you can download the current master branch from https://github.com/geodynamics/burnman/archive/master.zip.
106-
107-
To get Python 2.7.x (for example) running under Windows:
108106

109-
2. Download Python from http://www.python.org/ and install the version at C:\Python27\; the 32-bit version is recommended
110-
3. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy, download "numpy-MKL-1.6.2.win32-py2.7.exe" and install
111-
4. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#scipy, download "scipy-0.10.1.win32-py2.7.exe" and install
112-
5. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#matplotlib, download "matplotlib-1.1.1.win32-py2.7.exe" and install
107+
To get Python running under Windows:
108+
109+
1. Download Python from http://www.python.org/ and install
110+
2. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy, download and install
111+
3. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#scipy, download and install
112+
3. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#sympy, download and install
113+
4. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#matplotlib, download and install
114+
5. Download BurnMan from github (https://github.com/geodynamics/burnman)
113115
6. Open Python Shell (IDLE Python GUI)
114116
7. File -- Open -- find one of the example files
115117
8. Run the module (or press F5)
@@ -126,7 +128,7 @@ possible as well as each of the helpers involved with each example.
126128
your own).
127129
2. example_seismic.py (Explains the various seismic models included in
128130
BurnMan)
129-
3. example_composition.py (Explains how to create different mineralogical models)
131+
3. example_composition.py (Explains how to create different mineralogical models)
130132
4. example_user_input_materials.py (Explains how to create user-defined
131133
minerals)
132134
5. example_averaging.py (Explains how moduli and density are averaged to
@@ -136,18 +138,18 @@ possible as well as each of the helpers involved with each example.
136138
## About scripting in Python
137139

138140
Burnman has the advantage of being adaptable and extendable in easy scripts. The downside might be that we do not
139-
provide a graphical user interface. For those of you who are not familiar with python, we suspect it will still be
140-
relatively easy to adapt the scripts for computations and plotting.
141+
provide a graphical user interface. For those of you who are not familiar with python, we suspect it will still be
142+
relatively easy to adapt the scripts for computations and plotting.
141143
Here are some specific features and pitfalls on Python:
142144

143-
* Python uses specific indentation. A script might fail if a code block is not indented correctly. We use four spaces and no tabs,
145+
* Python uses specific indentation. A script might fail if a code block is not indented correctly. We use four spaces and no tabs,
144146
mixing these can give trouble.
145147
* Indices require square brackets and function or method calls parentheses (mainly different from Matlab).
146148
* The first index of an array is 0 (e.g. x[0])
147-
* Put dots after numbers to make them floats instead of integers (e.g. 5/3 will give 1 (Python 2.x rounds downward), while 5./3. will give 1.66666666667)
149+
* Put dots after numbers to make them floats instead of integers (e.g. 5/3 will give 1 (Python 3.x rounds downward), while 5./3. will give 1.66666666667)
148150

149151

150-
## Examples
152+
## Examples
151153

152154
example_beginner
153155
----------------
@@ -477,4 +479,3 @@ Here we show an example that does this, using the planet Mercury as motivation.
477479
* :doc:`mineral_database`
478480
* :class:`burnman.composite.Composite`
479481
* :func:`burnman.material.Material.evaluate`
480-

burnman/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55

66
"""
7-
Introducing BurnMan
8-
===================
7+
Introducing BurnMan |version|
8+
=============================
99
1010
Overview
1111
--------
@@ -82,7 +82,7 @@
8282
Requirements
8383
^^^^^^^^^^^^
8484
85-
- Python 2.7.x or Python 3.4+
85+
- Python 3.6+
8686
- Python modules: NumPy, SciPy, SymPy, Matplotlib
8787
8888
@@ -106,7 +106,7 @@
106106
107107
1. get Xcode
108108
2. If you don't have Python yet, download it (for free) from
109-
python.org/download . Make sure to use either Python 2.7 or Python 3.4+.
109+
python.org/download . Make sure to use either Python 3.6+.
110110
To check your version of python, type the following in a
111111
terminal: ``python --version``
112112
3. Install the latest Numpy version from http://sourceforge.net/projects/numpy/files/NumPy/
@@ -120,9 +120,9 @@
120120
Install under Windows
121121
^^^^^^^^^^^^^^^^^^^^^
122122
123-
To get Python 2.7.x (for example) running under Windows:
123+
To get Python running under Windows:
124124
125-
1. Download Python from http://www.python.org/ and install the version at C:\Python27\; the 32-bit version is recommended
125+
1. Download Python from http://www.python.org/ and install
126126
2. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#numpy, download and install
127127
3. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#scipy, download and install
128128
3. Go to http://www.lfd.uci.edu/~gohlke/pythonlibs/#sympy, download and install

sphinx/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
BurnMan: a thermodynamic and geophysics toolkit for the Earth and planetary sciences
7-
====================================================================================
6+
BurnMan |version|: a thermodynamic and geophysics toolkit for the Earth and planetary sciences
7+
===============================================================================================
88

99

1010
.. image:: burnjack-bar.png

0 commit comments

Comments
 (0)