Metadata-Version: 2.1
Name: polygraphs
Version: 0.0.1a0
Summary: Philosophical simulations
Home-page: https://github.com/alexandroskoliousis/polygraphs
Author: Alexandros Koliousis
Author-email: Alexandros Koliousis <ak@akoliousis.com>, Amil Mohanan <amil@mohanan.net>
License: MIT License
Project-URL: Repository, https://github.com/alexandroskoliousis/polygraphs
Project-URL: Documentation, https://akoliousis.com/polygraphs/
Keywords: philosophy,epistemology,simulation
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: PyYaml
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: networkx
Requires-Dist: six

# PolyGraphs

## Summary

## Quick Start: Desktop

```bash
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install --upgrade pip
$ python setup.py install
$ python -m dgl.backend.set_default_backend . pytorch
```
For a conda environment:
```bash
$ conda env create -n polygraphs --file environment.yml
$ conda activate polygraphs
$ python setup.py install
$ python -m dgl.backend.set_default_backend . pytorch
```

## Quick Start: Google Colaboratory

```bash
!git clone https://[token]@github.com/alexandroskoliousis/polygraphs.git
%cd polygraphs
!pip install -e .
!nvidia-smi
!pip install dgl-cu110
```

## Quick Start: Discovery Cluster

```bash
$ ssh username@login.discovery.neu.edu
[username@login-00 ~] $
```
For succinctness, I ommit the prefix `[username@login-00 ~]` in the following commands:
```bash
$ module load python
$ python -V
Python 3.8.1
$ git clone git@github.com:<account name>/polygraphs.git
$ cd polygraphs
$ echo "export PYTHONPATH=$PWD:$PYTHONPATH" >> ~/.bashrc
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ pip install --upgrade pip
(.venv) $ pip install -r requirements-discovery.txt
(.venv) $ python -m dgl.backend.set_default_backend pytorch
(.venv) $ python run.py --help
(.venv) $ srun --partition=short --nodes=1 --ntasks=1 --cpus-per-task=8 --mem=64GB --export=ALL --pty /bin/bash
```
Once on the allocated machine (say `vm`), run:
```bash
(.venv) [vm] $ python run.py -f configs/test.yaml
```

### Generating and running job array configurations
```bash
(.venv) $ python scripts/job-array-generator.py -f configs/zollman-effect/zollman-effect.yaml -e configs/explorables.json -a test
(.venv) $ sbatch run-array.script
```

## Analysing Simulation Results
See the documentation on using the [analysis module](https://github.com/alexandroskoliousis/polygraphs/blob/main/docs/guide/simulations/processing-results.md) from PolyGraphs to gather and process simulation results. 
