Spaces:
Running
Running
Commit
·
c9f1ebd
1
Parent(s):
42cd6af
Update docs
Browse files- README.md +3 -1
- docs/start.md +4 -4
README.md
CHANGED
|
@@ -155,7 +155,9 @@ the root directory of this repo:
|
|
| 155 |
```bash
|
| 156 |
docker build --pull --rm -f "Dockerfile" -t pysr "."
|
| 157 |
```
|
| 158 |
-
This builds an image called `pysr`.
|
|
|
|
|
|
|
| 159 |
```bash
|
| 160 |
docker run -it --rm -v "$PWD:/data" pysr ipython
|
| 161 |
```
|
|
|
|
| 155 |
```bash
|
| 156 |
docker build --pull --rm -f "Dockerfile" -t pysr "."
|
| 157 |
```
|
| 158 |
+
This builds an image called `pysr`. If you have issues building (for example, on Apple Silicon),
|
| 159 |
+
you can emulate an architecture that works by including: `--platform linux/amd64`.
|
| 160 |
+
You can then run this with:
|
| 161 |
```bash
|
| 162 |
docker run -it --rm -v "$PWD:/data" pysr ipython
|
| 163 |
```
|
docs/start.md
CHANGED
|
@@ -1,5 +1,3 @@
|
|
| 1 |
-
# Getting Started
|
| 2 |
-
|
| 3 |
# Installation
|
| 4 |
PySR uses both Julia and Python, so you need to have both installed.
|
| 5 |
|
|
@@ -21,7 +19,7 @@ Most common issues at this stage are solved
|
|
| 21 |
by [tweaking the Julia package server](https://github.com/MilesCranmer/PySR/issues/27).
|
| 22 |
to use up-to-date packages.
|
| 23 |
|
| 24 |
-
|
| 25 |
|
| 26 |
Let's create a PySR example. First, let's import
|
| 27 |
numpy to generate some test data:
|
|
@@ -103,7 +101,9 @@ the root directory of this repo:
|
|
| 103 |
```bash
|
| 104 |
docker build --pull --rm -f "Dockerfile" -t pysr "."
|
| 105 |
```
|
| 106 |
-
This builds an image called `pysr`.
|
|
|
|
|
|
|
| 107 |
```bash
|
| 108 |
docker run -it --rm -v "$PWD:/data" pysr ipython
|
| 109 |
```
|
|
|
|
|
|
|
|
|
|
| 1 |
# Installation
|
| 2 |
PySR uses both Julia and Python, so you need to have both installed.
|
| 3 |
|
|
|
|
| 19 |
by [tweaking the Julia package server](https://github.com/MilesCranmer/PySR/issues/27).
|
| 20 |
to use up-to-date packages.
|
| 21 |
|
| 22 |
+
# Quickstart
|
| 23 |
|
| 24 |
Let's create a PySR example. First, let's import
|
| 25 |
numpy to generate some test data:
|
|
|
|
| 101 |
```bash
|
| 102 |
docker build --pull --rm -f "Dockerfile" -t pysr "."
|
| 103 |
```
|
| 104 |
+
This builds an image called `pysr`. If you have issues building (for example, on Apple Silicon),
|
| 105 |
+
you can emulate an architecture that works by including: `--platform linux/amd64`.
|
| 106 |
+
You can then run this with:
|
| 107 |
```bash
|
| 108 |
docker run -it --rm -v "$PWD:/data" pysr ipython
|
| 109 |
```
|