added license, readme and modified package metadata

This commit is contained in:
Louis 2024-09-28 17:21:14 +02:00
parent 3e1347ffb3
commit 9e385c1e0d
3 changed files with 36 additions and 0 deletions

View file

@ -2,5 +2,11 @@
name = "geomag-wmm" name = "geomag-wmm"
version = "0.1.0" version = "0.1.0"
edition = "2021" edition = "2021"
license = "MIT"
description = "Calculate the Earth magnetic fields and their variation using WMM."
repository = "https://git.hostux.fr/ConstellationVFR/geomag-wmm"
readme = "README.md"
categories = ["science"]
keywords = ["wmm", "declination", "magnetic"]
[dependencies] [dependencies]

21
LICENSE.txt Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 Louis GUIDEZ
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

9
README.md Normal file
View file

@ -0,0 +1,9 @@
# geomag-wmm
WMM library used to calculate the magnetic declination.
You must download the `WMM.COF` file corresponding to the model you want to use, for instance, 2020-2025.
The code passes the 12 cases presented in the WMM description, Section 1.11 Table 6.
There is no guarantee that it is correct. It does not calculate the grid variation (yet) and does not warn the user if they calculate in a low precision area.