Merge branch 'tostt-patch-1'

cosinekitty · May 26, 2024 · 1c6a11c · 1c6a11c
2 parents 61dc070 + 898276e
commit 1c6a11c
Show file tree

Hide file tree

Showing 37 changed files with 63 additions and 35 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2023 Don Cross <[email protected]>
+Copyright (c) 2019-2024 Don Cross <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/demo/browser/astronomy.browser.js b/demo/browser/astronomy.browser.js
@@ -7,7 +7,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/demo/nodejs/astronomy.js b/demo/nodejs/astronomy.js
@@ -6,7 +6,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/demo/nodejs/calendar/astronomy.ts b/demo/nodejs/calendar/astronomy.ts
@@ -6,7 +6,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/demo/python/astronomy.py b/demo/python/astronomy.py
@@ -2,7 +2,7 @@
 #
 #    MIT License
 #
-#    Copyright (c) 2019-2023 Don Cross <[email protected]>
+#    Copyright (c) 2019-2024 Don Cross <[email protected]>
 #
 #    Permission is hereby granted, free of charge, to any person obtaining a copy
 #    of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/astro_vector.c b/generate/astro_vector.c
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/astro_vector.h b/generate/astro_vector.h
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/chebyshev.c b/generate/chebyshev.c
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/chebyshev.h b/generate/chebyshev.h
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/codegen.c b/generate/codegen.c
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/codegen.h b/generate/codegen.h
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/ephfile.c b/generate/ephfile.c
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/ephfile.h b/generate/ephfile.h
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/generate.c b/generate/generate.c
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/hydrogen/hydrogen.js b/generate/hydrogen/hydrogen.js
@@ -1,7 +1,7 @@
 /*
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/jpl_horizons_check.js b/generate/jpl_horizons_check.js
@@ -9,7 +9,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/jsdoc2md/js.hbs b/generate/jsdoc2md/js.hbs
@@ -118,6 +118,20 @@ and some [Node.js examples](../../demo/nodejs/).
 | [Seasons](#Seasons) | Finds the equinoxes and solstices for a given calendar year. |
 | [SunPosition](#SunPosition) | Calculates the Sun's apparent true ecliptic of date (ECT) coordinates as seen from the Earth. |
 
+### Date and time
+
+Astronomy Engine performs its calculations in UTC using the [`AstroTime`](#AstroTime) class,
+which does not contain timezone information.
+AstroTime objects can be created in several ways, including through a Javascript `Date` object.
+
+A JavaScript Date object in UTC can be created using:
+- a Z-terminating string: <code>new Date('2024-07-01T09:00:00Z')</code>
+- a set of numbers, where the month is 0-based: <code>new Date(Date.UTC(2024, 6, 1, 9, 0, 0))</code>
+
+Both examples create a Date object set to July 1st 2024 at 9:00:00 UTC.
+
+Note that, when displaying Date objects as strings (with `toUTCString()` for instance), JavaScript incorrectly refers to UTC as 'GMT'.
+
 ### Coordinate transforms
 
 The following orientation systems are supported.

diff --git a/generate/novas_body.h b/generate/novas_body.h
@@ -7,7 +7,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/template/astronomy.c b/generate/template/astronomy.c
@@ -4,7 +4,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/template/astronomy.cs b/generate/template/astronomy.cs
@@ -4,7 +4,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/template/astronomy.kt b/generate/template/astronomy.kt
@@ -4,7 +4,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/template/astronomy.py b/generate/template/astronomy.py
@@ -2,7 +2,7 @@
 #
 #    MIT License
 #
-#    Copyright (c) 2019-2023 Don Cross <[email protected]>
+#    Copyright (c) 2019-2024 Don Cross <[email protected]>
 #
 #    Permission is hereby granted, free of charge, to any person obtaining a copy
 #    of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/template/astronomy.ts b/generate/template/astronomy.ts
@@ -6,7 +6,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/generate/update_copyrights.py b/generate/update_copyrights.py
@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-# Copyright (c) 2019-2023 Don Cross <[email protected]>
+# Copyright (c) 2019-2024 Don Cross <[email protected]>
 import sys
 import re
 import datetime

diff --git a/source/c/astronomy.c b/source/c/astronomy.c
@@ -4,7 +4,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/source/c/astronomy.h b/source/c/astronomy.h
@@ -4,7 +4,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/source/csharp/astronomy.cs b/source/csharp/astronomy.cs
@@ -4,7 +4,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/source/js/README.md b/source/js/README.md
@@ -118,6 +118,20 @@ and some [Node.js examples](../../demo/nodejs/).
 | [Seasons](#Seasons) | Finds the equinoxes and solstices for a given calendar year. |
 | [SunPosition](#SunPosition) | Calculates the Sun's apparent true ecliptic of date (ECT) coordinates as seen from the Earth. |
 
+### Date and time
+
+Astronomy Engine performs its calculations in UTC using the [`AstroTime`](#AstroTime) class,
+which does not contain timezone information.
+AstroTime objects can be created in several ways, including through a Javascript `Date` object.
+
+A JavaScript Date object in UTC can be created using:
+- a Z-terminating string: <code>new Date('2024-07-01T09:00:00Z')</code>
+- a set of numbers, where the month is 0-based: <code>new Date(Date.UTC(2024, 6, 1, 9, 0, 0))</code>
+
+Both examples create a Date object set to July 1st 2024 at 9:00:00 UTC.
+
+Note that, when displaying Date objects as strings (with `toUTCString()` for instance), JavaScript incorrectly refers to UTC as 'GMT'.
+
 ### Coordinate transforms
 
 The following orientation systems are supported.

diff --git a/source/js/astronomy.browser.js b/source/js/astronomy.browser.js
@@ -7,7 +7,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/source/js/astronomy.browser.min.js b/source/js/astronomy.browser.min.js
diff --git a/source/js/astronomy.d.ts b/source/js/astronomy.d.ts
@@ -6,7 +6,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/source/js/astronomy.js b/source/js/astronomy.js
@@ -6,7 +6,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/source/js/astronomy.min.js b/source/js/astronomy.min.js
diff --git a/source/js/astronomy.ts b/source/js/astronomy.ts
@@ -6,7 +6,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/source/js/esm/astronomy.js b/source/js/esm/astronomy.js
@@ -6,7 +6,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt b/source/kotlin/src/main/kotlin/io/github/cosinekitty/astronomy/astronomy.kt
@@ -4,7 +4,7 @@
 
     MIT License
 
-    Copyright (c) 2019-2023 Don Cross <[email protected]>
+    Copyright (c) 2019-2024 Don Cross <[email protected]>
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

diff --git a/source/python/astronomy/astronomy.py b/source/python/astronomy/astronomy.py
@@ -2,7 +2,7 @@
 #
 #    MIT License
 #
-#    Copyright (c) 2019-2023 Don Cross <[email protected]>
+#    Copyright (c) 2019-2024 Don Cross <[email protected]>
 #
 #    Permission is hereby granted, free of charge, to any person obtaining a copy
 #    of this software and associated documentation files (the "Software"), to deal