Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/commons-stack/commons-simulator
Giving people the ability to easily simulate their own custom Commons with cadCAD
https://github.com/commons-stack/commons-simulator
Last synced: about 2 months ago
JSON representation
Giving people the ability to easily simulate their own custom Commons with cadCAD
- Host: GitHub
- URL: https://github.com/commons-stack/commons-simulator
- Owner: commons-stack
- Created: 2019-12-18T09:31:41.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T04:00:41.000Z (over 1 year ago)
- Last Synced: 2024-04-16T14:26:58.180Z (3 months ago)
- Language: Jupyter Notebook
- Homepage: https://sim.commonsstack.org/
- Size: 12.4 MB
- Stars: 32
- Watchers: 11
- Forks: 15
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
Lists
- awesome-dao-zh - Commons Simulator - 代币经济的简易模拟器 (DAO 工具)
README
# Commons Simulator
The Commons Simulator is a community project funded entirely by Gitcoin Grants, and undertaken by the Commons Stack’s dDev team. The Commons Simulator blends art and simulation into a dystopian sci-fi future where you travel back in time with cadCAD, a complex systems simulator that can predict the future.
You use cadCAD to help the fledgling RadicalxChange movement to customize their Cyber-Physical Commons to suit the needs of their community and save the world from ecosystem collapse!
## Server status
[](https://app.circleci.com/pipelines/github/commons-stack/commons-simulator)
## 1. Installation:
```sh
sudo apt install nodejs npm
sudo npm install -g yarn
sudo pip3 install -r requirements.txt
./start.sh
```
## 2. Running the simulation:
### Running the simulation on CLI
To run the simulation on the CLI with the
default parameters:
```sh
cd simulation
python simrunner.py
```
Adding a `-h` shows all the possible input parameters:
``` sh
python simrunner.py -h
usage: simrunner.py [-h] [--hatchers HATCHERS] [--proposals PROPOSALS]
[--hatch_tribute HATCH_TRIBUTE]
[--vesting_80p_unlocked VESTING_80P_UNLOCKED]
[--exit_tribute EXIT_TRIBUTE] [--kappa KAPPA]
[--days_to_80p_of_max_voting_weight DAYS_TO_80P_OF_MAX_VOTING_WEIGHT]
[--max_proposal_request MAX_PROPOSAL_REQUEST]
[-T TIMESTEPS_DAYS] [--random_seed RANDOM_SEED]
optional arguments:
-h, --help show this help message and exit
--hatchers HATCHERS
--proposals PROPOSALS
--hatch_tribute HATCH_TRIBUTE
--vesting_80p_unlocked VESTING_80P_UNLOCKED
--exit_tribute EXIT_TRIBUTE
--kappa KAPPA
--days_to_80p_of_max_voting_weight DAYS_TO_80P_OF_MAX_VOTING_WEIGHT
--max_proposal_request MAX_PROPOSAL_REQUEST
-T TIMESTEPS_DAYS, --timesteps_days TIMESTEPS_DAYS
```
After running the simulation, the results will be shown in the CLI as a dictionary.
### Development mode
To run a development mode server to have React hot reloading, do the same as above and in another terminal:
```sh
cd app
yarn start
```
A hot reloading server will pop up a browser tab on http://localhost:3000/
### Docker instructions
To run in a docker container
```sh
docker build -t commonssim .
docker run -p 5000:5000 commonssim
```
Go to http://localhost:5000/
### Website Front-End
The website Front-End repository can be found [here](https://github.com/commons-stack/c-sim-front-end).
## 3. Testing
From the main folder:
``` sh
python -m unittest discover -s simulation -p '*_test.py'
```
## 4. Resources
- [Play the game here!](https://sim.commonsstack.org/)
- [Read our Medium blog post](https://medium.com/commonsstack/the-commons-simulator-game-is-live-e1986615a105)
- [Donate to our Gitcoin grant](https://gitcoin.co/grants/277/commons-simulator-modeling-sustainable-funding-for)
- [Join out Telegram Channel](https://t.me/CSDdev)
- [Learn more about the Commons Stack](https://commonsstack.org/)