Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
54 lines (33 sloc) 2.03 KB

How to contribute to the project

Ideally, this package/library will grow into a community project, as a community-maintained resource for atomic physics community. Full code will be accessible from GitHub, so please fork the project, and submit improvements, additional modules, new features, or just suggest ideas. We have a list of features that can be potentially included.

Ideas for development

This is incomplete list of some of the modules that can be added to the library:

  • Dressing potentials
  • Magic wavelengths
  • Atom-wall interactions
  • Photoionization
  • Collisional cross-sections
  • Tensor polarisability
  • ... (add your own ideas)

Naming conventions

For the sake of consistency, readability and cross-linking with the written literature, please follow the following for contributions:

  • Names and method/subdivision should reflect structure of knowledge in atomic physics, NOT low-level implementation structure.
  • Names should be sensible to atomic physicists (even if they are not familiar with coding).
  • Use long self-descriptive variable names (so that the code is self-documented and readable in itself) and write short comment on functions of code subsections.
  • Use Google style docstrings for code documentation (we are using Sphinx Napoleon extension for generating documentation)
  • Add references to original papers in comments and docstrings.

Finally, this is the naming convention. of the original package. For consistency, we suggest following the same naming convention.

  • Submodules are lower case, separated by underscore. Example:

    import my_module_name
  • Classes are named in CamelCase, for example:

    class MyNewClass:
  • Class methods that return a value start with get in their name, and follow camelCase convention, for example:

    def getSumOfTwoNumbers(a,b):
        return a+b
  • Class methods don't return a value are named in camelCase, for example:

    def defineBasis():