Merge pull request #12 from dbrakenhoff/dev

add citation to Bruggemans book

Author: dbrakenhoff

CITATION.cff

@@ -0,0 +1,18 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+type: software
+title: "Analytical Solutions of Geohydrological Problems"
+authors:
+  - family-names: Bruggeman
+    given-names: G. A.
+date-released: 2025-11-03
+url: "https://github.com/dbrakenhoff/bruggeman"
+preferred-citation:
+  type: book
+  title: "Analytical Solutions of Geohydrological Problems"
+  authors:
+    - family-names: Bruggeman
+      given-names: G. A.
+  year: 1999
+  publisher: "Elsevier"
+  isbn: "978-0-444-81829-4"

README.md

@@ -6,7 +6,7 @@ The philosphy behind this repository is to collect implementations of
 analytical solutions so they are readily available for use in projects or for
 benchmarking other computations or models.
 
-Very much a work in progress.
+Very much a work in progress. Any contributions are welcome.
 
 ## Installation
 
@@ -30,3 +30,19 @@ To build the documentation locally:
 3. Enter the command `make html`.
 4. The documenation is contained in the `docs/_build` folder. Open `index.html` in
 your browser to view the documentation.
+
+## Contributing
+
+Any contributions are welcome! For the best results please follow the guidelines below:
+
+- The analytical solutions are generally stored in the `bruggeman/*.py` files. Please
+  select the appropriate python file for your solution. E.g. 1D flow solutions should be
+  stored `flow1d.py`. Create a new file if your solution does not fit into the currently
+  available files.
+- Create a notebook showcasing your solution. Put the notebook in `docs/examples/`.
+- Add the notebook under the appropriate section in `docs/examples/index.rst`. Follow
+  the examples in the file to add your notebook. Don't forget to add your notebook to the
+  table of contents as well.
+- Consider decorating your function with latexify by importing
+  `from bruggeman.general import latexify_function`. Follow the examples already present
+  in the python files. This will allow you to render your formulas with LateX in a notebook.