Skip to content

Commit 034ea40

Browse files
committed
README: Updated install instructions
Also added stuff about how to run the tests
1 parent 4f697b4 commit 034ea40

File tree

1 file changed

+32
-1
lines changed

1 file changed

+32
-1
lines changed

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
11
# Graph_lib
22

3-
A library for directed and undirected networks and related graph algorithms. WIP.
3+
A library for directed and undirected networks and related graph algorithms. WIP.
4+
5+
# Compilation and Running
6+
7+
If you want to use [`micromamba`](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html) as the package manager, create and activate the environment.
8+
9+
```bash
10+
micromamba create -f environment.yml
11+
micromamba activate seldonenv
12+
```
13+
14+
We use `meson` to compile and build Seldon.
15+
16+
```bash
17+
meson setup build
18+
meson compile -C build
19+
```
20+
21+
To install `seldon` to your `conda` environment, run the following:
22+
23+
```bash
24+
meson setup build --prefix $CONDA_PREFIX
25+
meson install -C build
26+
```
27+
28+
## Running Tests
29+
30+
To run the tests, go into the build directory and run the following:
31+
32+
```bash
33+
meson test
34+
```

0 commit comments

Comments
 (0)