Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
socsim-dev/README.md
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
68 lines (39 sloc)
1.91 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Socsim | |
## Todo | |
### next | |
* improve readme | |
* test: does it still work on linux? (yes!) | |
* improve socsim-oversimplified.md untill it reflects everything in the pdf | |
* clean the repository | |
* improve the makefile so things are clear | |
* write r-code to test some simulations and wether they still have the same results as they should | |
* provide packages and installing instructions | |
* populate the socsim-course repository (add a readme ) | |
### someday in the future | |
* create an R-package | |
* with windows and linux binaries | |
* maybe with some extra-functions to read the output-files | |
* find out why the c++-version on Windows segfaults | |
* remove unused code | |
* census? | |
### This site will start out with Socsim as it exists at Berkeley August 2019. The plan is to remove extraneous obsolete code; improve comments and documentation and then to start a new public site with clean simple and inviting version of Socsim for eager scientists. | |
# Readme | |
# SOCSIM Microsiumlation | |
## About SOCSIM | |
What is SOCSIM? What can I do with it? Is socsim the right tool for me? | |
SOCSIM is a microsimulator.... can be used to.... developed since... now.. | |
## Getting Started | |
How to run a simulation | |
### Prerequisites | |
### Installation | |
### Usage | |
## (further) Documentation | |
The documentation is not complete yet (give us another 50 years), but can be found here: ... (maybe something like readthedocs.com ?) | |
look at the [example projects](http://github.molgen.mpg.de/cmason/socsimsamples) which are extensively commented. It's like a tutorial. | |
There's also [SOCSIM Oversimplified](https://lab.demog.berkeley.edu/socsim/CurrentDocs/socsimOversimplified.pdf) to get a somewhat deeper understanding of the underlying stuff. | |
## Development | |
How to compile socsim to change the code. This is for more advanced users (mostly for ourselfes). | |
## Licence | |
The source code is released under a ... | |
## Citation | |
Please cite every paper from... if SOCSIM was helpful for you. |