popjson
v1.4.5
Published
PopJSON: JSON representation for dynamically-structured multi-process matrix population models
Readme
PopJSON
JSON-based representation of population dynamics models.
Includes a parser for the Population model and its Python wrapper.
Please check this page for usage instructions.
We are working on the specifications.
Installation
PopJSON has two parts:
- The PopJSON package (Node.js, installed via
npm). - The Population C library, which provides the backend engine.
Install PopJSON (Node.js package)
npm install -g popjsonThis installs the popjson CLI globally.
Install Population (C library)
PopJSON depends on the Population library.
For convenience, this repository includes an installer script in the root folder:
./install.population.shSystem-wide installation (recommended)
sudo ./install.population.shThis builds and installs Population under /usr/local and updates your environment.
Local installation (no sudo required)
./install.population.sh --localThis installs Population under ~/.local and updates your ~/.bashrc.
Options
Run with --help for the full list of options:
./install.population.sh --helpKey options:
--prefix PREFIX: custom installation prefix (default:/usr/local)--tmpdir TMPDIR: temporary working directory (default:/tmp/population)--local: user-local installation under~/.local--verbose: print detailed process information--keep-tests: keep temporary test files instead of deleting them--version: print installer script version
Installation logs are saved as population-install.log in the working directory.
Quick Start
Install both PopJSON and Population in one go:
# Install PopJSON CLI and Population backend (system-wide)
sudo ./install.population.sh
# Verify installation
popjson --versionIf you prefer a local (non-sudo) installation:
./install.population.sh --localLicense & Disclaimer
This project is distributed under the terms of the license in LICENSE.
Disclaimer:
The installer script (install.population.sh) is provided “AS IS”, without warranty of any kind.
Use at your own risk. The authors assume no responsibility for any issues, damages, or losses resulting from its use.
