Skip to content

Commit

Permalink
README: Updated install instructions
Browse files Browse the repository at this point in the history
Also added stuff about how to run the tests
  • Loading branch information
amritagos committed May 17, 2024
1 parent 4f697b4 commit 3a6b0e9
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,34 @@
# Graph_lib

A library for directed and undirected networks and related graph algorithms. WIP.
A library for directed and undirected networks and related graph algorithms. WIP.

# Compilation and Running

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.

```bash
micromamba create -f environment.yml
micromamba activate seldonenv
```

We use `meson` to compile and build Seldon.

```bash
meson setup build
meson compile -C build
```

To install `seldon` to your `conda` environment, run the following:

```bash
meson setup build --prefix $CONDA_PREFIX
meson install -C build
```

## Running Tests

To run the tests, go into the build directory and run the following:

```bash
meson test
```

0 comments on commit 3a6b0e9

Please sign in to comment.