Skip to content

Commit 9399a50

Browse files
authored
Merge pull request #30 from azukov/main
Updating README.md to clarify where Mac instructions end fixes #22
2 parents 7dfc171 + da4644b commit 9399a50

File tree

1 file changed

+41
-30
lines changed

1 file changed

+41
-30
lines changed

README.md

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -23,34 +23,48 @@ git clone https://github.com/PyORBIT-Collaboration/PyORBIT3.git
2323
```
2424

2525
### Pip Setup
26+
**PIP** based setup is more involved, we recommend using **conda** if unsure.
27+
#### Prepare OS
28+
The following commands may require root access.
29+
30+
<details>
31+
<summary> Click for Ubuntu-based distributions</summary>
32+
33+
```bash
34+
apt-get update
35+
apt-get install -y build-essential python3 libfftw3-dev python3-venv libpython3-dev pkg-config git
36+
```
37+
</details>
38+
39+
<details>
40+
<summary> Click for Redhat-based distributions</summary>
41+
42+
```bash
43+
dnf group install -y "Development Tools"
44+
dnf install -y python3-devel fftw3-devel
45+
```
46+
</details>
47+
48+
<details>
49+
<summary> Click for Mac</summary>
50+
51+
Install Homebrew, make sure that homebrew programs are in the **$PATH** (optional step in Homebrew installation)
52+
```bash
53+
brew install pkg-config fftw
54+
```
55+
</details>
56+
57+
#### Create Python virtual environment
58+
Make sure that you have the correct python version installed. We require python>3.9. <br>
59+
Create virtual environment.
60+
```
61+
python3 -m venv .po3
62+
. .po3/bin/activate
63+
pip install -U pip
64+
pip install -r requirements.txt
65+
pip install -U setuptools
66+
```
2667

27-
#### Ubuntu based distributions:
28-
```
29-
sudo apt-get update
30-
sudo apt-get install -y build-essential python3 libfftw3-dev python3-venv libpython3-dev pkg-config git
31-
```
32-
33-
#### Redhat based distributions:
34-
```
35-
dnf group install -y "Development Tools"
36-
dnf install -y python3-devel fftw3-devel
37-
```
38-
39-
#### MacOS
40-
Install Homebrew, make sure that homebrew programs are in the **$PATH** (optional step in Homebrew installation)
41-
```bash
42-
brew install pkg-config fftw
43-
```
44-
45-
Make sure that you have the correct python version installed. We require python>3.9. <br>
46-
Create virtual environment.
47-
```
48-
python3 -m venv .po3
49-
. .po3/bin/activate
50-
pip install -U pip
51-
pip install -r requirements.txt
52-
pip install -U setuptools
53-
```
5468

5569
### Conda Setup
5670

@@ -93,6 +107,3 @@ Navigate to your **examples** directory and launch tracking of SNS linac.
93107
cd examples/SNS_Linac/pyorbit3_linac_model/
94108
python pyorbit3_sns_linac_mebt_hebt2.py
95109
```
96-
97-
98-

0 commit comments

Comments
 (0)