fluiddyn issueshttps://foss.heptapod.net/fluiddyn/fluiddyn/-/issues2022-02-21T11:56:54Zhttps://foss.heptapod.net/fluiddyn/fluiddyn/-/issues/22Replace pkg_resources.resource_filename in fluiddoc.fluiddocset2022-02-21T11:56:54ZPierre AugierReplace pkg_resources.resource_filename in fluiddoc.fluiddocset`pkg_resources` is [provided by setuptools](https://setuptools.pypa.io/en/latest/pkg_resources.html).
We don't want to depend on setuptools at runtime. In the doc, it is mentioned "Use of pkg_resources is discouraged in favor of importl...`pkg_resources` is [provided by setuptools](https://setuptools.pypa.io/en/latest/pkg_resources.html).
We don't want to depend on setuptools at runtime. In the doc, it is mentioned "Use of pkg_resources is discouraged in favor of importlib.resources, importlib.metadata, and their backports (resources, metadata). Please consider using those libraries instead of pkg_resources."
However, I don't know yet how to replace our use of `pkg_resources.resource_filename` in https://foss.heptapod.net/fluiddyn/fluiddyn/-/blob/branch/default/fluiddoc/fluiddocset.py#L49.
```python
doc_src = Path(resource_filename(pkg_name, "/")).parent / "doc"
```https://foss.heptapod.net/fluiddyn/fluiddyn/-/issues/21Add CITATION.cff files2021-11-09T18:37:39ZAshwin V. MohananAdd CITATION.cff filesSaw this today at [xarray's repo](https://github.com/pydata/xarray/pull/5956). Supported by GitHub, Zenodo and Zotero. So it would be good to have.
- https://citation-file-format.github.io/
- https://docs.github.com/en/repositories/mana...Saw this today at [xarray's repo](https://github.com/pydata/xarray/pull/5956). Supported by GitHub, Zenodo and Zotero. So it would be good to have.
- https://citation-file-format.github.io/
- https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
Tools to generate them:
- https://citation-file-format.github.io/cff-initializer-javascript/#/
- https://github.com/citation-file-format/citation-file-format#tools-to-work-with-citationcff-files-wrench
- [ ] fluiddyn
- [ ] fluidfft
- [ ] fluidsimhttps://foss.heptapod.net/fluiddyn/fluiddyn/-/issues/19Doc about Windows2020-12-02T13:39:11ZPierre AugierDoc about WindowsWe could add few informations about how to setup a correct environment on Windows.
Example:
```json
[
{
// Make changes here to the powershell.exe profile.
"guid": "{61c54bbd-c2c6-5271-96e7-0...We could add few informations about how to setup a correct environment on Windows.
Example:
```json
[
{
// Make changes here to the powershell.exe profile.
"guid": "{61c54bbd-c2c6-5271-96e7-009a87ff44bf}",
"name": "Windows PowerShell",
"commandline": "powershell.exe",
"hidden": false
},
{
// Make changes here to the cmd.exe profile.
"guid": "{0caa0dad-35be-5f56-a8ff-afceeeaa6101}",
"name": "Invite de commandes",
"commandline": "cmd.exe",
"hidden": false
},
{
"guid": "{391a7fb7-cd0c-4800-909f-4f6680e79725}",
"name": "Anaconda PowerShell",
"commandline": "powershell.exe -ExecutionPolicy ByPass -NoExit -Command & '%USERPROFILE%\\miniconda3\\shell\\condabin\\conda-hook.ps1' ; conda activate '%USERPROFILE%\\miniconda3'",
"colorscheme": "Solarized Light",
"startingDirectory": "%USERPROFILE%",
"hidden": false
}
]
```Pierre AugierPierre Augierhttps://foss.heptapod.net/fluiddyn/fluiddyn/-/issues/13Use MyST anq fix the doc (links in notebooks)2022-02-05T21:10:54ZPierre AugierUse MyST anq fix the doc (links in notebooks)Use MyST-NB (https://myst-nb.readthedocs.io):
- [x] fluiddyn
- [ ] fluidfft
- [x] fluidsim
- [ ] fluidlab
- [ ] fluidimage
- [ ] fluidsht
See for example https://fluiddyn.readthedocs.io/en/latest/ipynb/overview.htmlUse MyST-NB (https://myst-nb.readthedocs.io):
- [x] fluiddyn
- [ ] fluidfft
- [x] fluidsim
- [ ] fluidlab
- [ ] fluidimage
- [ ] fluidsht
See for example https://fluiddyn.readthedocs.io/en/latest/ipynb/overview.htmlPierre AugierPierre Augierhttps://foss.heptapod.net/fluiddyn/fluiddyn/-/issues/12Changelog and communication2024-01-10T19:43:16ZAshwin V. MohananChangelog and communicationSince now only occasionally involved in the project, I notice something that could improve the overall project health of FluidDyn.
# The good
With the merge request based workflow, things are a bit more cohesive than it used to be. Tha...Since now only occasionally involved in the project, I notice something that could improve the overall project health of FluidDyn.
# The good
With the merge request based workflow, things are a bit more cohesive than it used to be. Thanks to Heptapod, I can follow the development via this page: https://foss.heptapod.net/groups/fluiddyn/-/activity. :100:
# The bad
Changelog for some recent releases are too short. See fluidfft 0.3.1 and transonic 0.4.3 for instance, which is a variation of "various bug fixes". It does not help the reader. :confused:
# What can change
Project maintainance is a tough job already. I understand. But one could produce better changelogs. Some solutions
1. [`towncrier`](https://github.com/twisted/towncrier) is a package which assists developers in this regard. I have not used it personally, but [looks like NumPy has adopted it](https://github.com/numpy/numpy/blob/99010006fabea949d13aae8caea10abf97cbaed9/pyproject.toml#L10-L71).
2. [Keep a changelog](https://keepachangelog.com/en/1.0.0/) has a nice template for clearly defining what has changed. It also helps in deciding whether the next release would be a major / minor / patch release.
Once this improved changelog is ready and a new version is out, send it out to the mailing list. Then, tweet the link to the mailing list archive so that others know about it.
# To Do
- [x] fluidsim
- [ ] fluidfft
- [ ] fluidimage
- [ ] fluidlab
# pyproject.toml pending
- [ ] fluidsht
- [ ] transonicMaintainenceAshwin V. MohananAshwin V. Mohananhttps://foss.heptapod.net/fluiddyn/fluiddyn/-/issues/6New contributors, start here!2023-07-01T20:44:37ZAshwin V. MohananNew contributors, start here!Hope you have read our documentation on [developer essentials](https://fluiddyn.readthedocs.io/en/latest/advice_developers.html), and especially on [setting up Mercurial](https://fluiddyn.readthedocs.io/en/latest/mercurial_heptapod.html)...Hope you have read our documentation on [developer essentials](https://fluiddyn.readthedocs.io/en/latest/advice_developers.html), and especially on [setting up Mercurial](https://fluiddyn.readthedocs.io/en/latest/mercurial_heptapod.html)
This is an open issue dedicated for newcomers to be added as "developer". You are welcome to join FluidDyn project. Request with a message below.