update readme
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
**Setup Steps Before Running CIGEN**
After cloning start the Docker environment
cd ~/cigen
./run_docker.sh
Built required LLVM plugin libTraceDiffPass.so (NOT in README):
cd ~/cigen/baseline_civ
make -f Makefile.plugin
Initialized CIgen environment:
cd ~/cigen
source setup.sh
Navigated to the chosen GSL test directory:
cd ~/cigen/gsl_test/
**Running CIGEN to Generate These Results**
Ran CIgen test engine(NOT in README):
python3 ../../driver/test_engine_cigen.py
Ran optimizer + plotting:
python3 run_gsl.py -name=de -plot
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the README and compare its setup and execution instructions with run_docker.sh, Makefile.plugin, setup.sh, driver/test_engine_cigen.py, and gsl_test/run_gsl.py. Document the missing commands and their sequence, then verify that a reader can follow the README from cloning through generating and plotting results.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100