Skip to content

Commit 1855dd6

Browse files
authored
- even more concise install instructions for nimplex per #10
1 parent 20a1305 commit 1855dd6

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

README.md

+5-9
Original file line numberDiff line numberDiff line change
@@ -58,18 +58,14 @@ helps with the Python bindings. You can do it with a single command:
5858
nimble install -y arraymancer nimpy
5959
```
6060

61-
Finally, you can clone the repository and compile the library with:
61+
Now, you can update the `nimplex` submodule repository and compile it for `AMMap`. You want to do so in a way that creates its **Python bindings**. You will need slightly different flags depending on your system configuration, but for Unix (Linux/MacOS) you can do so with commands below, after making sure you are in the root `AMMap` directory:
6262
```shell
63-
git clone https://github.com/amkrajewski/nimplex
64-
cd nimplex
65-
nim c -r -d:release nimplex.nim --benchmark
63+
git submodule update --init --recursive
64+
nim c --d:release --threads:on --app:lib --out:nimplex.so nimplex/src/nimplex.nim
65+
nim c --d:release --threads:on --app:lib --out:utils/plotting.so nimplex/src/nimplex/utils/plotting.nim
6666
```
67-
which will compile the library and run a few benchmarks to make sure everything runs smoothly. You should then see a compiled binary file `nimplex` in the current directory which exposes the CLI tool.
6867

69-
Now, for `AMMap` you want to use the **Python bindings**, so you need to also compile the library with slightly different flags (depending on your system configuration) like so for Linux/MacOS, after moving back into the root AMMAP directory:
70-
```cmd
71-
nim c --d:release --threads:on --app:lib --out:nimplex.so nimplex/src/nimplex.nim && nim c --d:release --threads:on --app:lib --out:utils/plotting.so nimplex/src/nimplex/utils/plotting.nim
72-
```
68+
For Windows and other platforms, you should consult [`nimpy`](https://github.com/yglukhov/nimpy) instructions.
7369

7470

7571
### CALPHAD Tools

0 commit comments

Comments
 (0)