SNO RAMSES

FAQ for developers

This is still work in progress. If you have dev related questions, please ask them in the Ramses’s forum, and they may be featured here!

  • I want to alter one of the physical models in RAMSES, but I don’t know the code, where do I start?
    • You should take a look at the tutorials here, and the developer documentation here
    • Check if someone more experienced in the RAMSES community is willing to give you advice on the slack or the google group. -> page de contacts, github discussions
    • If you’re modifying an existing part of the code, looking for relevant parameters in the .nml file, and searching for them in the code could be a smart way to find the code snippets that you will need to alter.
    • When developing your code, please respect the guidelines [link]
  • I want to get involved with developing RAMSES, who should I talk to?
    • Check if there’s an active working group that would suit you. Inquire on the github discussions page to see if there is interest, and ask an SNO member if you’d like to open a new working group.
  • I have an idea for some development for RAMSES. How can I check if it’salready underway and possibly contribute to this existing project? -> contacts
  • I’ve developed a new module or physical model for RAMSES, what tests should it pass?
    • There are a limited number of standard tests setup for the code. See the documentation here.
    • Get in touch with the test working group  https://ramses.cnrs.fr/about/#working-groups
    • Ideally you should provide a minimal working example (e.g. test of implemented solver versus an analytical solution, or a small idealized simulation setup to test a star formation model)
    • NB: please also provide documentation for your new module (see WG doc…)
  • I’ve developed a new feature in RAMSES, do I have to make it public?
    • No, but it would be greatly appreciated.
  • I want to share my new development, how do i do ?
    • The tests and doc mentioned above become mandatory here…  
  • How do I find out what units X variable is in, in subroutine Y, line Z?
    • Check the documentation
    • Hopefully there will be a comment somewhere in the code if you just grep the variable name. Most variables are in code units throughout the code, in some key computations they may be taken into CGS units using the unit_l, unit_t and unit_d factors (for length, time, and density, respectively).[cosmo… what about idealised]
    • Don’t hesitate to reach out to SNO members, and ask a question on the github discussions