# ARNICA or All Recurrent No-brainers In Cerfacs Applications
We keep there all the simple little things we regularly need, to ease the pain.
For example a cartesian-to-cylindrical conversion around x-axis, with a specific convention
```python
def rtheta2yz(rrr, theta):
""" return yz fror rtheta ,
theta in radians measure of ange in the yz plane,
- range -pi/pi
- 0 on the y+ axis (z=0, y>0)
spanning -pi to pi
0pi=0deg
Y
^
|
|
-0.5pi=-90deg o------>Z 0.5pi=90deg
"""
yyy = rrr * np.cos(theta)
zzz = rrr * np.sin(theta)
return yyy, zzz
```
Ok trivial, but I did mention it was a no-brainer no?
Having these bits in a single repository adds the following values:
- Unitary testing.
- linting.
- Automatic documentation.
- Can be used by others in Cerfacs.
In Arnica, useful features related to Computational Fluid Dynamics (CFD) are implemented, namely:
1. *CFD related tools* aiming to be used together with the Reactive software suite [AVBP](http://www.cerfacs.fr/avbp7x/).
2. *CFD related bare functionnalities* such as ParaView-readable XDMF writers from Numpy arrays, axi-symetric shell generators, 2D finite differences solvers, _etc._
Contributors are, for the moment, the CERFACS/[COOP Team](http://cerfacs.fr/coop/team/) that can be reached at [coop@cerfacs.fr](coop@cerfacs.fr).
Documentation is available on internal Forge [arnica at Nitrox](http://open-source.pg.cerfacs.fr/arnica) or on [arnica at ReadTheDocs](https://arnica.readthedocs.io/en/latest/).
Source code is hoster on internal Forge [arnica at Nitrox](https://nitrox.cerfacs.fr/open-source/arnica), where all the devops occur.
It is then mirrored at [arnica at gitlab.com/cerfacs](https://gitlab.com/cerfacs/arnica)
If you are willing to contribute, please read carefully the guide in the `CONTRIBUTING.md` file.
# Installation
Arnica can be installed directly in your Python 3 environnement by running the command:
```
pip install arnica
```
This command will install Arnica and all its dependencies (if needed). Once this step is over you can use arnica as a Python module in a script:
```python
import arnica
```
# License
CeCILL-B FREE SOFTWARE LICENSE AGREEMENT
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/cerfacs/arnica",
"name": "arnica",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Tool,CFD,Scientific Computing",
"author": "CoopTeam-CERFACS",
"author_email": "coop@cerfacs.fr",
"download_url": "https://files.pythonhosted.org/packages/73/d7/a921537e4401591708d3f40833de3c3933e028ff582faf4b5948503a24b5/arnica-1.13.1.tar.gz",
"platform": null,
"description": "# ARNICA or All Recurrent No-brainers In Cerfacs Applications\n\n We keep there all the simple little things we regularly need, to ease the pain.\n\nFor example a cartesian-to-cylindrical conversion around x-axis, with a specific convention \n\n```python\ndef rtheta2yz(rrr, theta):\n \"\"\" return yz fror rtheta ,\n theta in radians measure of ange in the yz plane,\n - range -pi/pi\n - 0 on the y+ axis (z=0, y>0)\n spanning -pi to pi\n\n 0pi=0deg\n Y\n ^\n |\n |\n -0.5pi=-90deg o------>Z 0.5pi=90deg\n\n \"\"\"\n yyy = rrr * np.cos(theta)\n zzz = rrr * np.sin(theta)\n return yyy, zzz\n```\n\nOk trivial, but I did mention it was a no-brainer no?\nHaving these bits in a single repository adds the following values:\n\n- Unitary testing.\n- linting.\n- Automatic documentation.\n- Can be used by others in Cerfacs.\n\nIn Arnica, useful features related to Computational Fluid Dynamics (CFD) are implemented, namely:\n\n 1. *CFD related tools* aiming to be used together with the Reactive software suite [AVBP](http://www.cerfacs.fr/avbp7x/).\n 2. *CFD related bare functionnalities* such as ParaView-readable XDMF writers from Numpy arrays, axi-symetric shell generators, 2D finite differences solvers, _etc._\n \nContributors are, for the moment, the CERFACS/[COOP Team](http://cerfacs.fr/coop/team/) that can be reached at [coop@cerfacs.fr](coop@cerfacs.fr).\n\nDocumentation is available on internal Forge [arnica at Nitrox](http://open-source.pg.cerfacs.fr/arnica) or on [arnica at ReadTheDocs](https://arnica.readthedocs.io/en/latest/).\n\nSource code is hoster on internal Forge [arnica at Nitrox](https://nitrox.cerfacs.fr/open-source/arnica), where all the devops occur.\nIt is then mirrored at [arnica at gitlab.com/cerfacs](https://gitlab.com/cerfacs/arnica)\n\nIf you are willing to contribute, please read carefully the guide in the `CONTRIBUTING.md` file.\n\n# Installation\n\nArnica can be installed directly in your Python 3 environnement by running the command:\n\n```\npip install arnica\n```\n\nThis command will install Arnica and all its dependencies (if needed). Once this step is over you can use arnica as a Python module in a script:\n\n```python\nimport arnica\n```\n\n# License\n\nCeCILL-B FREE SOFTWARE LICENSE AGREEMENT\n",
"bugtrack_url": null,
"license": "",
"summary": "All Recurrent No-brainers In Cerfacs Applications",
"version": "1.13.1",
"split_keywords": [
"tool",
"cfd",
"scientific computing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d6455467d5459f38e6482eb795084df5ed014636b709d35563f6e9e8613b65e0",
"md5": "75bd9b1a4d9e269ac0f06217e28cbce7",
"sha256": "c64fba03df5b027f57d044b7837ef5d2af202bff32c5204ca29ec84f319a1efb"
},
"downloads": -1,
"filename": "arnica-1.13.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "75bd9b1a4d9e269ac0f06217e28cbce7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 66785,
"upload_time": "2023-03-21T12:23:30",
"upload_time_iso_8601": "2023-03-21T12:23:30.163141Z",
"url": "https://files.pythonhosted.org/packages/d6/45/5467d5459f38e6482eb795084df5ed014636b709d35563f6e9e8613b65e0/arnica-1.13.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "73d7a921537e4401591708d3f40833de3c3933e028ff582faf4b5948503a24b5",
"md5": "e0012cc503dea504884ba44c17f67f2c",
"sha256": "65148e710011ed663984dcac344a528e5851a5a762ebd347fd82c93b67c67b00"
},
"downloads": -1,
"filename": "arnica-1.13.1.tar.gz",
"has_sig": false,
"md5_digest": "e0012cc503dea504884ba44c17f67f2c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 151576,
"upload_time": "2023-03-21T12:23:32",
"upload_time_iso_8601": "2023-03-21T12:23:32.133139Z",
"url": "https://files.pythonhosted.org/packages/73/d7/a921537e4401591708d3f40833de3c3933e028ff582faf4b5948503a24b5/arnica-1.13.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-21 12:23:32",
"github": false,
"gitlab": true,
"bitbucket": false,
"gitlab_user": "cerfacs",
"gitlab_project": "arnica",
"lcname": "arnica"
}
JSON