This is the Binder repo for the Carbon simulator. The permament github URL for this repo is bancorprotocol/carbon-simulator-binder. Please refer to the simulator repo at bancorprotocol/carbon-simulator and the Carbon project website carbondefi.xyz for more information. On the site you will find in particular the litepaper, whitepaper and the patent application.
This repo is mostly designed to be used with Binder, a web-based service for hosting Jupyter notebooks and labs. If you want to run the simulator locally, we recommend cloning the main repo instead, and following the installation instructions there. This gives you access to not only the stable main branch of the simulator that is available in PyPi, but also to the full source code and the beta branch that contains the latest code.
To launch this repo on binder, you can use the badge above to launch the lab. You can also
- go to the lab environment here, or
- to the litepaper example sheet here.
Note that the launch process can be slow at times: if the repo has been recently changed and you are the first one use it then the docker images may have to be built. Even if the docker images are available, it may take a moment to transfer the required images to the federation server
If you nevertheless want to run this repo locally, you can do so by running
$ pip install -r requirements.txt
which in particular will install the carbon simulator from PyPi
$ pip install carbon-simulator
We recommend using a virtual environment to ensure that there are no conflicts with other local installations.