All: How to contribute configuration files

How to contribute a new configuration file to NFTsim

Ideally, a new configuration file should use the same fork & pull workflow model as for any other code contribution.

If you don't know how to use the above workflow and still would like the developers to include an example of your work, follow the next steps:

1. Open an issue on NFTsim issue tracker with the name [New config file: short relevant description of the model]

2. In the new issue, either copy the config file as a block of code, or attach the config file to the issue. GitHub won't recognize the extension .conf, so you'll have to change the file extension to .txt or .md.

3. We will mainly consider configuration files that showcase some feature of published work; or, work under review for which a preprint is available online.

4. Add the relevant information about (i) relevant article where the same or a similar configuration file was used; (ii) operating system used to run the file; (iii) computer specs; (iv) estimated runtime; (v) NFTsim version; and, (vi) the link to your NFTsim fork, if you forked the base repository.

5. Add figures with the expected output. The developers will execute your configuration file and try to reproduce the figures.