Skip to content

Commit

Permalink
docs: fix broken links & typos (#93)
Browse files Browse the repository at this point in the history 
* docs: fix broken links and typo in md files

* docs: fix some more typos
  • Loading branch information
@leahaeusel
leahaeusel authored Jan 13, 2025
1 parent b3c7fd2 commit 25feb64
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 22 deletions.
29 changes: 14 additions & 15 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,31 @@ be overwritten!

# Changelog

* [allow-multiple-input-files](https://gitlab.lrz.de/queens_community/queens/-/commit/b886962e69012246e47415e03170e2c9437390c1) (2024-10-09): natively support multiple input files in jobscript driver
* [allow-multiple-input-files](https://github.com/queens-py/queens/commit/b886962e69012246e47415e03170e2c9437390c1) (2024-10-09): Natively support multiple input files in jobscript driver

* [remove_interfaces_and_push_parameters_to_drivers](https://gitlab.lrz.de/queens_community/queens/-/commit/c6fc37b9d5d6bc76cf7fc5492a147e26671def57) (2024-10-01): Remove interfaces and push parameters to drivers
* [remove_interfaces_and_push_parameters_to_drivers](https://github.com/queens-py/queens/commit/c6fc37b9d5d6bc76cf7fc5492a147e26671def57) (2024-10-01): Remove interfaces and push parameters to drivers

* [remove-direct-python-interface](https://gitlab.lrz.de/queens_community/queens/-/commit/0c911c4fd40549c147052e8110ca2a8478eb1ffb) (2024-09-05): Remove direct python interface and replace by pool scheduler and python driver
* [remove-direct-python-interface](https://github.com/queens-py/queens/commit/0c911c4fd40549c147052e8110ca2a8478eb1ffb) (2024-09-05): Remove direct python interface and replace by pool scheduler and python driver

* [delete_old_random_field_implementation](https://gitlab.lrz.de/queens_community/queens/-/commit/1dde8f0a4e6063a68ac7519502252403eab1fb67) (2024-05-21): Delete old random field implementation
* [delete_old_random_field_implementation](https://github.com/queens-py/queens/commit/1dde8f0a4e6063a68ac7519502252403eab1fb67) (2024-05-21): Delete old random field implementation

* [dask_backend](https://gitlab.lrz.de/queens_community/queens/-/commit/6d07402543432bf9a72c83535f6bf5de76881c8b) (2023-07-24): With this tag the 'old' workflow with interface-resources-scheduler-driver as well as the singularity dependency is removed. The simulation handling as well as remote communication is handled by dask.
* [dask_backend](https://github.com/queens-py/queens/commit/6d07402543432bf9a72c83535f6bf5de76881c8b) (2023-07-24): With this tag the 'old' workflow with interface-resources-scheduler-driver as well as the singularity dependency is removed. The simulation handling as well as remote communication is handled by dask.

* [delete_old_mf_modules](https://gitlab.lrz.de/queens_community/queens/-/commit/a1dd60e20bd276516be93f18fc34bc90e3829140) (2023-03-29): Delete untested and deprecated multi-fidelity modules.
* [delete_old_mf_modules](https://github.com/queens-py/queens/commit/a1dd60e20bd276516be93f18fc34bc90e3829140) (2023-03-29): Delete untested and deprecated multi-fidelity modules.

* [jinja_injection](https://gitlab.lrz.de/queens_community/queens/-/commit/7e2cc701658e9739a397d6001cd32f4a44444673) (2023-01-31): QUEENS now uses jinja2 as injector back-end. Hence, the placeholder in the input templates needs double braces, e.g. `{{ place_holder_name }}`.
* [jinja_injection](https://github.com/queens-py/queens/commit/7e2cc701658e9739a397d6001cd32f4a44444673) (2023-01-31): QUEENS now uses jinja2 as injector back-end. Hence, the placeholder in the input templates needs double braces, e.g. `{{ place_holder_name }}`.

* [add_yaml_input_support](https://gitlab.lrz.de/queens_community/queens/-/commit/ab21ab029f8e0a7088d2c86e59eb841762a06828) (2022-07-21): Besides the json format, we now also support yaml format for the QUEENS input files.
* [add_yaml_input_support](https://github.com/queens-py/queens/commit/ab21ab029f8e0a7088d2c86e59eb841762a06828) (2022-07-21): Besides the json format, we now also support yaml format for the QUEENS input files.

* [external-python-modules](https://gitlab.lrz.de/queens_community/queens/-/commit/2e2c726b978236a158100909733c7f099fc2fe6f) (2022-07-13): We now allow overwriting and overloading QUEENS modules and classes by external Python modules.
* [external-python-modules](https://github.com/queens-py/queens/commit/2e2c726b978236a158100909733c7f099fc2fe6f) (2022-07-13): We now allow overwriting and overloading QUEENS modules and classes by external Python modules.

* [variable-class-rebuild](https://gitlab.lrz.de/queens_community/queens/-/commit/acc3ae6a13f51a8e49f1fd908e53002e712867da) (2022-07-07): Variable class was rebuild: modern and elegant!
* [variable-class-rebuild](https://github.com/queens-py/queens/commit/acc3ae6a13f51a8e49f1fd908e53002e712867da) (2022-07-07): Variable class was rebuilt: modern and elegant!

## [v1.2](https://gitlab.lrz.de/queens_community/queens/-/commit/206fcbe6200dac29e44d2243c4afc6ef2515f0c6) (2022-02-04)
## [v1.2](https://github.com/queens-py/queens/commit/206fcbe6200dac29e44d2243c4afc6ef2515f0c6) (2022-02-04)
New design of QUEENS post_post module

## [v1.1](https://gitlab.lrz.de/queens_community/queens/-/commit/93a93661151cf09adc42f219c69d92749c93834d) (2022-01-03)
QUEENS is now installed using pip. Additionally all required packages are pinned to a fixed version.
## [v1.1](https://github.com/queens-py/queens/commit/93a93661151cf09adc42f219c69d92749c93834d) (2022-01-03)
QUEENS is now installed using pip. Additionally, all required packages are pinned to a fixed version.

## [v1.0](https://gitlab.lrz.de/queens_community/queens/-/commit/5c380cf7095e874e7670785d17ae7867e20a7982) (2021-11-04)
## [v1.0](https://github.com/queens-py/queens/commit/5c380cf7095e874e7670785d17ae7867e20a7982) (2021-11-04)
Release 1.0 (status prior transition)

2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The [QUEENS maintainers][queens community] have the right and responsibility to

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to [Lea Häusel](mailto:[email protected]), [Sebastian Brandstäter](mailto:[email protected]) or any other [QUEENS maintainer][queens community]. All complaints will be reviewed and investigated promptly and fairly.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to [Lea Häusel](mailto:[email protected]), [Sebastian Brandstäter](mailto:[email protected]), or any other [QUEENS maintainer][queens community]. All complaints will be reviewed and investigated promptly and fairly.

The [QUEENS maintainers][queens community] are obligated to respect the privacy and security of the reporter of any incident.

Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ contributions, irrespective of size and complexity.
## :rotating_light: Issues
Issues are generally used to remind or inform yourself or others about certain things in the
software. We use them to report bugs, start a feature request, or plan tasks. In case you have a
general question please refer to [Github Discussions](https://github.com/queens-py/queens/discussion).
general question, please refer to [GitHub Discussions](https://github.com/queens-py/queens/discussions).

To create an issue select one of our templates and provide a detailed description. We use labels
to organize our issues, please label it with the mandatory labels
To create an issue, select one of our templates and provide a detailed description. We use labels
to organize our issues, so please label issues with the mandatory labels
- `status:` label
- `topic:` label
- `type:` label
Expand Down Expand Up @@ -49,16 +49,16 @@ pre-commit install --hook-type commit-msg
#### Coding style
QUEENS code follows the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style. Non-compliant code
will lead to failing CI pipelines and will therefore not be merged.
The code checks are conducted with [pylint](https://pylint.org/),
[isort](https://github.com/PyCQA/isort), and [black](https://github.com/psf/black).
The code checks are conducted with [Pylint](https://pylint.org/),
[isort](https://github.com/PyCQA/isort), and [Black](https://github.com/psf/black).
Compliance with [Google style docstrings](https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings)
is checked with [pydocstyle](https://github.com/PyCQA/pydocstyle).
Complete and meaningful docstrings are required as they are used to generate the
[documentation](#reading-and-writing-documentation).

#### Commit messages
Please provide meaningful commit messages based on the
[convential commits guidelines](https://www.conventionalcommits.org/en/v1.0.0/).
[Conventional Commits guidelines](https://www.conventionalcommits.org/en/v1.0.0/).
These are verified by the commit-msg hook (managed by [commitizen](https://github.com/commitizen-tools/commitizen)).

### 4. Test your code
Expand Down

0 comments on commit 25feb64

Please sign in to comment.