From 92d856f57e6815abd1eb4efa55c865357c71ebff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Attila=20Abrud=C3=A1n?= Date: Sun, 6 Aug 2017 10:19:41 +0200 Subject: [PATCH] Add license and docs, exported from Codeplex --- docs/Documentation.md | 9 ++ docs/Home.html | 95 ++++++++++++++++++++ docs/Operations.md | 105 ++++++++++++++++++++++ docs/Routines.md | 203 ++++++++++++++++++++++++++++++++++++++++++ license.md | 34 +++++++ 5 files changed, 446 insertions(+) create mode 100644 docs/Documentation.md create mode 100644 docs/Home.html create mode 100644 docs/Operations.md create mode 100644 docs/Routines.md create mode 100644 license.md diff --git a/docs/Documentation.md b/docs/Documentation.md new file mode 100644 index 0000000..18cb933 --- /dev/null +++ b/docs/Documentation.md @@ -0,0 +1,9 @@ +**WWA Documentation** + +[Routines](Routines) +[Operations](Operations) + +Please note: the C# verions is intended to retain identical functionality to the SOFA library, but made distinct through different function prefixes (**iau** prefix renamed to **wwa**). + +For more information please read the SOFA Documentation: +[http://www.iausofa.org/cookbooks.html](http://www.iausofa.org/cookbooks.html) diff --git a/docs/Home.html b/docs/Home.html new file mode 100644 index 0000000..1b8c92f --- /dev/null +++ b/docs/Home.html @@ -0,0 +1,95 @@ +
+

Current WWA Library release based on :  SOFA Library Issue 2017-04-20 for ANSI C

+

Project Description
+
+World Wide Astronomy - WWA
+Set of C# algorithms and procedures that implement standard models used in fundamental astronomy.
+Offers more than 160 routines for fundamental astronomy, including time scales (including dealing with leap seconds), Earth rotation, sidereal time, precession, nutation, polar motion, astrometry and transforms between various reference systems (e.g. BCRS, + ICRS, GCRS, CIRS, TIRS, ITRS). The subprograms are supported by 55 vector/matrix routines.
+
+This program is derived from the International Astronomical Union's
+SOFA (Standards of Fundamental Astronomy) software collection.
+http://www.iausofa.org
+
+The WWA code does not itself constitute software provided by and/or endorsed by SOFA.
+This version is intended to retain identical functionality to the SOFA library, but
+made distinct through different function names (prefixes) and C# language specific
+modifications in code.
+
+Contributor
+Attila Abrudán

+

If you make income with the help of this library please donate to the contributor (help to keep up to date the C# version).

+

SOFA Software License
+NOTICE TO USER:
+
+BY USING THIS SOFTWARE YOU ACCEPT THE FOLLOWING SIX TERMS AND
+CONDITIONS WHICH APPLY TO ITS USE.
+
+1. The Software is owned by the IAU SOFA Board ("SOFA").
+
+2. Permission is granted to anyone to use the SOFA software for any
+purpose, including commercial applications, free of charge and
+without payment of royalties, subject to the conditions and
+restrictions listed below.
+
+3. You (the user) may copy and distribute SOFA source code to others,
+and use and adapt its code and algorithms in your own software,
+on a world-wide, royalty-free basis. That portion of your
+distribution that does not consist of intact and unchanged copies
+of SOFA source code files is a "derived work" that must comply
+with the following requirements:
+
+a) Your work shall be marked or carry a statement that it
+(i) uses routines and computations derived by you from
+software provided by SOFA under license to you; and
+(ii) does not itself constitute software provided by and/or
+endorsed by SOFA.
+
+b) The source code of your derived work must contain descriptions
+of how the derived work is based upon, contains and/or differs
+from the original SOFA software.
+
+c) The names of all routines in your derived work shall not
+include the prefix "iau" or "sofa" or trivial modifications
+thereof such as changes of case.
+
+d) The origin of the SOFA components of your derived work must
+not be misrepresented; you must not claim that you wrote the
+original software, nor file a patent application for SOFA
+software or algorithms embedded in the SOFA software.
+
+e) These requirements must be reproduced intact in any source
+distribution and shall apply to anyone to whom you have
+granted a further right to modify the source code of your
+derived work.
+
+Note that, as originally distributed, the SOFA software is
+intended to be a definitive implementation of the IAU standards,
+and consequently third-party modifications are discouraged. All
+variations, no matter how minor, must be explicitly marked as
+such, as explained above.
+
+4. You shall not cause the SOFA software to be brought into
+disrepute, either by misuse, or use for inappropriate tasks, or
+by inappropriate modification.
+
+5. The SOFA software is provided "as is" and SOFA makes no warranty
+as to its use or performance. SOFA does not and cannot warrant
+the performance or results which the user may obtain by using the
+SOFA software. SOFA makes no warranties, express or implied, as
+to non-infringement of third party rights, merchantability, or
+fitness for any particular purpose. In no event will SOFA be
+liable to the user for any consequential, incidental, or special
+damages, including any lost profits or lost savings, even if a
+SOFA representative has been advised of such damages, or for any
+claim by any third party.
+
+6. The provision of any version of the SOFA software under the terms
+and conditions specified herein does not imply that future
+versions will also be made available under the same terms and
+conditions.
+
+In any published work or commercial product which uses the SOFA
+software directly, acknowledgement (see www.iausofa.org) is
+appreciated.

+
\ No newline at end of file diff --git a/docs/Operations.md b/docs/Operations.md new file mode 100644 index 0000000..e3effda --- /dev/null +++ b/docs/Operations.md @@ -0,0 +1,105 @@ +**OPERATIONS INVOLVING P-VECTORS AND R-MATRICES** + + +Initialize+ + + ZP zero p-vector + ZR initialize r-matrix to null + IR initialize r-matrix to identity + + +Copy/extend/extract+ + + CP copy p-vector + CR copy r-matrix + + +Build rotations+ + + RX rotate r-matrix about x + RY rotate r-matrix about y + RZ rotate r-matrix about z + + +Spherical/Cartesian conversions+ + + S2C spherical to unit vector + C2S unit vector to spherical + S2P spherical to p-vector + P2S p-vector to spherical + + +Operations on vectors+ + + PPP p-vector plus p-vector + PMP p-vector minus p-vector + PPSP p-vector plus scaled p-vector + PDP inner (=scalar=dot) product of two p-vectors + PXP outer (=vector=cross) product of two p-vectors + PM modulus of p-vector + PN normalize p-vector returning modulus + SXP multiply p-vector by scalar + + +Operations on matrices+ + + RXR r-matrix multiply + TR transpose r-matrix + + +Matrix-vector products+ + + RXP product of r-matrix and p-vector + TRXP product of transpose of r-matrix and p-vector + + +Separation and position-angle+ + + SEPP angular separation from p-vectors + SEPS angular separation from spherical coordinates + PAP position-angle from p-vectors + PAS position-angle from spherical coordinates + + +Rotation vectors+ + + RV2M r-vector to r-matrix + RM2V r-matrix to r-vector + + +**OPERATIONS INVOLVING PV-VECTORS** + + +Initialize+ + + ZPV zero pv-vector + + +Copy/extend/extract+ + + CPV copy pv-vector + P2PV append zero velocity to p-vector + PV2P discard velocity component of pv-vector + + +Spherical/Cartesian conversions+ + + S2PV spherical to pv-vector + PV2S pv-vector to spherical + + +Operations on vectors+ + + PVPPV pv-vector plus pv-vector + PVMPV pv-vector minus pv-vector + PVDPV inner (=scalar=dot) product of two pv-vectors + PVXPV outer (=vector=cross) product of two pv-vectors + PVM modulus of pv-vector + SXPV multiply pv-vector by scalar + S2XPV multiply pv-vector by two scalars + PVU update pv-vector + PVUP update pv-vector discarding velocity + + +Matrix-vector products+ + + RXPV product of r-matrix and pv-vector + TRXPV product of transpose of r-matrix and pv-vector + + +**OPERATIONS ON ANGLES** + + ANP normalize radians to range 0 to 2pi + ANPM normalize radians to range -pi to +pi + A2TF decompose radians into hours, minutes, seconds + A2AF decompose radians into degrees, arcminutes, arcseconds + AF2A degrees, arcminutes, arcseconds to radians + D2TF decompose days into hours, minutes, seconds + TF2A hours, minutes, seconds to radians + TF2D hours, minutes, seconds to days diff --git a/docs/Routines.md b/docs/Routines.md new file mode 100644 index 0000000..229852d --- /dev/null +++ b/docs/Routines.md @@ -0,0 +1,203 @@ + **Calendars** + + CAL2JD Gregorian calendar to Julian Day number + EPB Julian Date to Besselian Epoch + EPB2JD Besselian Epoch to Julian Date + EPJ Julian Date to Julian Epoch + EPJ2JD Julian Epoch to Julian Date + JD2CAL Julian Date to Gregorian year, month, day, fraction + JDCALF Julian Date to Gregorian date for formatted output + + **Astrometry** + + AB apply stellar aberration + APCG prepare for ICRS <-> GCRS, geocentric, special + APCG13 prepare for ICRS <-> GCRS, geocentric + APCI prepare for ICRS <-> CIRS, terrestrial, special + APCI13 prepare for ICRS <-> CIRS, terrestrial + APCO prepare for ICRS <-> observed, terrestrial, special + APCO13 prepare for ICRS <-> observed, terrestrial + APCS prepare for ICRS <-> CIRS, space, special + APCS13 prepare for ICRS <-> CIRS, space + APER insert ERA into context + APER13 update context for Earth rotation + APIO prepare for CIRS <-> observed, terrestrial, special + APIO13 prepare for CIRS <-> observed, terrestrial + ATCI13 catalog -> CIRS + ATCIQ quick ICRS -> CIRS + ATCIQN quick ICRS -> CIRS, multiple deflections + ATCIQZ quick astrometric ICRS -> CIRS + ATCO13 ICRS -> observed + ATIC13 CIRS -> ICRS + ATICQ quick CIRS -> ICRS + ATCIQN quick CIRS -> ICRS, multiple deflections + ATIO13 CIRS -> observed + ATIOQ quick CIRS -> observed + ATOC13 observed -> astrometric ICRS + ATOI13 observed -> CIRS + ATOIQ quick observed -> CIRS + LD light deflection by a single solar-system body + LDN light deflection by multiple solar-system bodies + LDSUN light deflection by the Sun + PMPX apply proper motion and parallax + PVTOB observatory position and velocity + REFCO refraction constants + PMSAFE apply proper motion, with zero-parallax precautions + STARPM apply proper motion + + **Time scales** + + D2DTF format 2-part JD for output + DAT Delta(AT) (=TAI-UTC) for a given UTC date + DTDB TDB-TT + DTF2D encode time and date fields into 2-part JD + TAITT TAI to TT + TAIUT1 TAI to UT1 + TAIUTC TAI to UTC + TCBTDB TCB to TDB + TCGTT TCG to TT + TDBTCB TDB to TCB + TDBTT TDB to TT + TTTAI TT to TAI + TTTCG TT to TCG + TTTDB TT to TDB + TTUT1 TT to UT1 + UT1TAI UT1 to TAI + UT1TT UT1 to TT + UT1UTC UT1 to UTC + UTCTAI UTC to TAI + UTCUT1 UTC to UT1 + + **Earth rotation angle and sidereal time** + + EE00 equation of the equinoxes, IAU 2000 + EE00A equation of the equinoxes, IAU 2000A + EE00B equation of the equinoxes, IAU 2000B + EE06A equation of the equinoxes, IAU 2006/2000A + EECT00 equation of the equinoxes complementary terms, IAU 2000 + EQEQ94 equation of the equinoxes, IAU 1994 + ERA00 Earth rotation angle, IAU 2000 + GMST00 Greenwich mean sidereal time, IAU 2000 + GMST06 Greenwich mean sidereal time, IAU 2006 + GMST82 Greenwich mean sidereal time, IAU 1982 + GST00A Greenwich apparent sidereal time, IAU 2000A + GST00B Greenwich apparent sidereal time, IAU 2000B + GST06 Greenwich apparent ST, IAU 2006, given NPB matrix + GST06A Greenwich apparent sidereal time, IAU 2006/2000A + GST94 Greenwich apparent sidereal time, IAU 1994 + + **Ephemerides (limited precision)** + + EPV00 Earth position and velocity + PLAN94 major-planet position and velocity + + **Precession, nutation, polar motion** + + BI00 frame bias components, IAU 2000 + BP00 frame bias and precession matrices, IAU 2000 + BP06 frame bias and precession matrices, IAU 2006 + BPN2XY extract CIP X,Y coordinates from NPB matrix + C2I00A celestial-to-intermediate matrix, IAU 2000A + C2I00B celestial-to-intermediate matrix, IAU 2000B + C2I06A celestial-to-intermediate matrix, IAU 2006/2000A + C2IBPN celestial-to-intermediate matrix, given NPB matrix, IAU 2000 + C2IXY celestial-to-intermediate matrix, given X,Y, IAU 2000 + C2IXYS celestial-to-intermediate matrix, given X,Y and s + C2T00A celestial-to-terrestrial matrix, IAU 2000A + C2T00B celestial-to-terrestrial matrix, IAU 2000B + C2T06A celestial-to-terrestrial matrix, IAU 2006/2000A + C2TCIO form CIO-based celestial-to-terrestrial matrix + C2TEQX form equinox-based celestial-to-terrestrial matrix + C2TPE celestial-to-terrestrial matrix given nutation, IAU 2000 + C2TXY celestial-to-terrestrial matrix given CIP, IAU 2000 + EO06A equation of the origins, IAU 2006/2000A + EORS equation of the origins, given NPB matrix and s + FW2M Fukushima-Williams angles to r-matrix + FW2XY Fukushima-Williams angles to X,Y + NUM00A nutation matrix, IAU 2000A + NUM00B nutation matrix, IAU 2000B + NUM06A nutation matrix, IAU 2006/2000A + NUMAT form nutation matrix + NUT00A nutation, IAU 2000A + NUT00B nutation, IAU 2000B + NUT06A nutation, IAU 2006/2000A + NUT80 nutation, IAU 1980 + NUTM80 nutation matrix, IAU 1980 + OBL06 mean obliquity, IAU 2006 + OBL80 mean obliquity, IAU 1980 + PB06 zeta,z,theta precession angles, IAU 2006, including bias + PFW06 bias-precession Fukushima-Williams angles, IAU 2006 + PMAT00 precession matrix (including frame bias), IAU 2000 + PMAT06 PB matrix, IAU 2006 + PMAT76 precession matrix, IAU 1976 + PN00 bias/precession/nutation results, IAU 2000 + PN00A bias/precession/nutation, IAU 2000A + PN00B bias/precession/nutation, IAU 2000B + PN06 bias/precession/nutation results, IAU 2006 + PN06A bias/precession/nutation results, IAU 2006/2000A + PNM00A classical NPB matrix, IAU 2000A + PNM00B classical NPB matrix, IAU 2000B + PNM06A classical NPB matrix, IAU 2006/2000A + PNM80 precession/nutation matrix, IAU 1976/1980 + P06E precession angles, IAU 2006, equinox based + POM00 polar motion matrix + PR00 IAU 2000 precession adjustments + PREC76 accumulated precession angles, IAU 1976 + S00 the CIO locator s, given X,Y, IAU 2000A + S00A the CIO locator s, IAU 2000A + S00B the CIO locator s, IAU 2000B + S06 the CIO locator s, given X,Y, IAU 2006 + S06A the CIO locator s, IAU 2006/2000A + SP00 the TIO locator s', IERS 2003 + XY06 CIP, IAU 2006/2000A, from series + XYS00A CIP and s, IAU 2000A + XYS00B CIP and s, IAU 2000B + XYS06A CIP and s, IAU 2006/2000A + + **Fundamental arguments for nutation etc.** + + FAD03 mean elongation of the Moon from the Sun + FAE03 mean longitude of Earth + FAF03 mean argument of the latitude of the Moon + FAJU03 mean longitude of Jupiter + FAL03 mean anomaly of the Moon + FALP03 mean anomaly of the Sun + FAMA03 mean longitude of Mars + FAME03 mean longitude of Mercury + FANE03 mean longitude of Neptune + FAOM03 mean longitude of the Moon's ascending node + FAPA03 general accumulated precession in longitude + FASA03 mean longitude of Saturn + FAUR03 mean longitude of Uranus + FAVE03 mean longitude of Venus + + **Star space motion** + + PVSTAR space motion pv-vector to star catalog data + STARPV star catalog data to space motion pv-vector + + **Star catalog conversions** + + FK52H transform FK5 star data into the Hipparcos system + FK5HIP FK5 to Hipparcos rotation and spin + FK5HZ FK5 to Hipparcos assuming zero Hipparcos proper motion + H2FK5 transform Hipparcos star data into the FK5 system + HFK5Z Hipparcos to FK5 assuming zero Hipparcos proper motion + + **Galactic coordinates** + + G2ICRS transform IAU 1958 galactic coordinates to ICRS + ICRS2G transform ICRS coordinates to IAU 1958 Galactic + + **Geodetic/geocentric** + + EFORM a,f for a nominated Earth reference ellipsoid + GC2GD geocentric to geodetic for a nominated ellipsoid + GC2GDE geocentric to geodetic given ellipsoid a,f + GD2GC geodetic to geocentric for a nominated ellipsoid + GD2GCE geodetic to geocentric given ellipsoid a,f + + + **Obsolete** + + C2TCEO former name of C2TCIO diff --git a/license.md b/license.md new file mode 100644 index 0000000..f9f04e2 --- /dev/null +++ b/license.md @@ -0,0 +1,34 @@ +Ms-RL +Microsoft Reciprocal License (Ms-RL) + +This license governs use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software. + +1. Definitions + +The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under U.S. copyright law. + +A "contribution" is the original software, or any additions or changes to the software. + +A "contributor" is any person that distributes its contribution under this license. + +"Licensed patents" are a contributor's patent claims that read directly on its contribution. + +2. Grant of Rights + +(A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create. + +(B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software. + +3. Conditions and Limitations + +(A) Reciprocal Grants- For any file you distribute that contains code from the software (in source code or binary format), you must provide recipients the source code to that file along with a copy of this license, which license will govern that file. You may license other files that are entirely your own work and do not contain code from the software under any terms you choose. + +(B) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks. + +(C) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically. + +(D) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software. + +(E) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license. + +(F) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement. \ No newline at end of file