AstroToolkit 1.5.3__tar.gz → 1.6.0__tar.gz

{astrotoolkit-1.5.3 → astrotoolkit-1.6.0}/MANIFEST.in

@@ -1,7 +1,7 @@
-include src/AstroToolkit/Timeseries/pyaov/*.f90
-include src/AstroToolkit/Timeseries/pyaov/*.bat
-include src/AstroToolkit/Timeseries/pyaov/*.sh
-include src/AstroToolkit/Timeseries/pyaov/aovwrapper
-include src/AstroToolkit/Timeseries/pyaov/README/*.pdf
-include src/AstroToolkit/Timeseries/pyaov/README/*.txt
+include src/AstroToolkit/Timeseries/pyaov/*.f90
+include src/AstroToolkit/Timeseries/pyaov/*.bat
+include src/AstroToolkit/Timeseries/pyaov/*.sh
+include src/AstroToolkit/Timeseries/pyaov/aovwrapper
+include src/AstroToolkit/Timeseries/pyaov/README/*.pdf
+include src/AstroToolkit/Timeseries/pyaov/README/*.txt
 include src/AstroToolkit/Plotting/*.fits

astrotoolkit-1.6.0/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: AstroToolkit
+Version: 1.6.0
+Summary: A package for the gathering, plotting and analysis of astronomical data.
+Author-email: Ethan Moorfield <ethan.moorfield@hotmail.co.uk>
+Project-URL: Homepage, https://github.com/WD-planets/AstroToolkit
+Project-URL: Issues, https://github.com/WD-planets/AstroToolkit/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: astropy==6.0.1
+Requires-Dist: astroquery==0.4.7
+Requires-Dist: bokeh==3.4.1
+Requires-Dist: cmasher==1.8.0
+Requires-Dist: matplotlib==3.8.4
+Requires-Dist: importlib_resources==6.4.0
+Requires-Dist: numpy==1.26.4
+Requires-Dist: pandas==2.2.2
+Requires-Dist: Requests==2.31.0
+Requires-Dist: beautifulsoup4==4.12.3
+Requires-Dist: scipy==1.13.0
+Requires-Dist: selenium==4.21.0
+Requires-Dist: lightkurve==2.4.2
+Requires-Dist: PyQt5==5.15.10
+Requires-Dist: numba==0.60.0
+
+AstroToolkit
+============
+
+AstroToolkit (ATK) is a set of tools for fetching, plotting, and analysing astronomical data.
+
+<br>
+
+Features
+--------
+
+* A GUI through which most of the package can be utilised
+* Command-line integration
+* Scripting integration for greater control
+* Proper motion correction through Gaia, utilised across the entire package
+* Light curve, spectral energy distribution, spectrum and image queries from a wide range of surveys
+* Gaia HRD queries for any Gaia sources
+* In-built interactive plotting support for all of the above as shareable .html pages that retain all interactivity
+* Data queries from any [Vizier](https://vizier.cds.unistra.fr/) survey, with many commonly used surveys built-in
+* Reddening queries from [Stilism](https://stilism.obspm.fr/) and [GDRE](https://irsa.ipac.caltech.edu/applications/DUST/)
+* Data analysis tools: 
+    * Timeseries analysis using a variety of methods (Lomb-Scargle, AOVMHW, ...)
+    * Light curve binning, clipping, phase folding and sigma-clipping
+    * Image detection and tracer overlays
+    * Spectral band highlighting
+    * SED-spectrum overlays
+    * Data quality filtering (optional)
+* Lossless saving and reading of any ATK data structures to / from local files
+* Datapage creation, allowing the combination of any of the above into a single page with additional elements specifically designed for this purpose
+* No hard coded parameters - built-in configuration support allows the user to personalise the package to their specific needs.
+* All data structures are available to the user, allowing them to use all ATK routines on non-ATK data
+* Other quality-of-life tools, such as coordinate conversions, .fits file reading and [Vizier](https://vizier.cds.unistra.fr/) / [SIMBAD](https://simbad.u-strasbg.fr/simbad/) searches
+
+<br>
+
+Documentation
+-------------
+
+Full documentation for the package can be found [here](https://astrotoolkit.readthedocs.io/en/latest/). 

astrotoolkit-1.6.0/README.md

@@ -0,0 +1,38 @@
+AstroToolkit
+============
+
+AstroToolkit (ATK) is a set of tools for fetching, plotting, and analysing astronomical data.
+
+<br>
+
+Features
+--------
+
+* A GUI through which most of the package can be utilised
+* Command-line integration
+* Scripting integration for greater control
+* Proper motion correction through Gaia, utilised across the entire package
+* Light curve, spectral energy distribution, spectrum and image queries from a wide range of surveys
+* Gaia HRD queries for any Gaia sources
+* In-built interactive plotting support for all of the above as shareable .html pages that retain all interactivity
+* Data queries from any [Vizier](https://vizier.cds.unistra.fr/) survey, with many commonly used surveys built-in
+* Reddening queries from [Stilism](https://stilism.obspm.fr/) and [GDRE](https://irsa.ipac.caltech.edu/applications/DUST/)
+* Data analysis tools: 
+    * Timeseries analysis using a variety of methods (Lomb-Scargle, AOVMHW, ...)
+    * Light curve binning, clipping, phase folding and sigma-clipping
+    * Image detection and tracer overlays
+    * Spectral band highlighting
+    * SED-spectrum overlays
+    * Data quality filtering (optional)
+* Lossless saving and reading of any ATK data structures to / from local files
+* Datapage creation, allowing the combination of any of the above into a single page with additional elements specifically designed for this purpose
+* No hard coded parameters - built-in configuration support allows the user to personalise the package to their specific needs.
+* All data structures are available to the user, allowing them to use all ATK routines on non-ATK data
+* Other quality-of-life tools, such as coordinate conversions, .fits file reading and [Vizier](https://vizier.cds.unistra.fr/) / [SIMBAD](https://simbad.u-strasbg.fr/simbad/) searches
+
+<br>
+
+Documentation
+-------------
+
+Full documentation for the package can be found [here](https://astrotoolkit.readthedocs.io/en/latest/). 

{astrotoolkit-1.5.3 → astrotoolkit-1.6.0}/pyproject.toml

@@ -1,41 +1,48 @@
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools]
-include-package-data = true
-
-[project]
-name = "AstroToolkit"
-version = "1.5.3"
-authors = [
-  { name="Ethan Moorfield", email="ethan.moorfield@hotmail.co.uk"},
-]
-description = "A package for the gathering and plotting of astronomical data."
-readme = "README.md"
-requires-python = ">=3.11"
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "Operating System :: OS Independent",
-]
-dependencies = [
-    "astropy==6.0.1",
-    "astroquery==0.4.7",
-    "bokeh==3.4.1",
-    "cmasher==1.8.0",
-    "matplotlib==3.8.4",
-    "importlib_resources==6.4.0",
-    "numpy==1.26.4",
-    "pandas==2.2.2",
-    "Requests==2.31.0",
-    "beautifulsoup4==4.12.3",
-    "scipy==1.13.0",
-    "selenium==4.21.0",
-    "lightkurve==2.4.2",
-	"PyQt5==5.15.10",
-	"numba==0.60.0",
-]
-
-[project.urls]
-Homepage = "https://github.com/WD-planets/AstroToolkit"
-Issues = "https://github.com/WD-planets/AstroToolkit/issues"
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[project]
+name = "AstroToolkit"
+version = "1.6.0"
+authors = [
+  { name="Ethan Moorfield", email="ethan.moorfield@hotmail.co.uk"},
+]
+description = "A package for the gathering, plotting and analysis of astronomical data."
+readme = "README.md"
+requires-python = ">=3.11"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "astropy==6.0.1",
+    "astroquery==0.4.7",
+    "bokeh==3.4.1",
+    "cmasher==1.8.0",
+    "matplotlib==3.8.4",
+    "importlib_resources==6.4.0",
+    "numpy==1.26.4",
+    "pandas==2.2.2",
+    "Requests==2.31.0",
+    "beautifulsoup4==4.12.3",
+    "scipy==1.13.0",
+    "selenium==4.21.0",
+    "lightkurve==2.4.2",
+    "PyQt5==5.15.10",
+    "numba==0.60.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/WD-planets/AstroToolkit"
+Issues = "https://github.com/WD-planets/AstroToolkit/issues"
+
+[project.scripts]
+ATKgui = "bin.opengui_command:main"
+ATKtsbuild = "bin.tsbuild_command:main"
+ATKtsguide =  "bin.tsguide_command:main"
+ATKquery = "bin.atkquery_command:main"
+ATKread = "bin.atkread_command:main"

{astrotoolkit-1.5.3 → astrotoolkit-1.6.0}/setup.cfg

@@ -1,4 +1,4 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[egg_info]
+tag_build = 
+tag_date = 0
+

astrotoolkit-1.6.0/src/AstroToolkit/Config.py

@@ -0,0 +1,74 @@
+"""
+Most defaults in ATK can be changed via a config file. This module allows for the configuration file to be viewed and edited.
+"""
+
+from .Configuration.baseconfig import ConfigStruct
+
+config = ConfigStruct()
+config.read_config()
+
+
+def editconfig(key, value):
+    """
+    Allows for config values to be edited. See :ref:`Config Keys` for a description of available keys.
+
+    :param str key: config key
+    :param str value: value to assign to this config key
+
+    :return: None
+
+    |
+
+    """
+    from .Input.input_validation import check_inputs
+
+    inputs = check_inputs({"key": key, "value": value}, "edit")
+    key, value = inputs["key"], inputs["value"]
+
+    print("Written change to ATKConfig.ini. New Values:\n")
+    config.edit_config(key, value)
+
+
+def openconfig():
+    """
+    Opens the config in the default text editor. See :ref:`Config Keys` for a description of available keys.
+
+    :return: None
+
+    |
+
+    """
+    config = ConfigStruct()
+    path = config.config_file
+
+    import webbrowser
+
+    webbrowser.open(path)
+
+
+def outputconfig():
+    """
+    Prints the current config file to stdout.
+
+    :return: None
+
+    |
+
+    """
+    print("Current ATKConfig.ini values:\n")
+    config.read_config()
+    config.output_config()
+
+
+def resetconfig():
+    """
+    Resets the config to default values.
+
+    :return: None
+
+    |
+
+    """
+    print("Resetting ATKConfig.ini to default values...\n")
+    config.set_default_config()
+    config.write_config()

{astrotoolkit-1.5.3 → astrotoolkit-1.6.0}/src/AstroToolkit/Configuration/baseconfig.py

@@ -1,174 +1,174 @@
-import configparser
-import os
-
-
-class ConfigStruct(object):
-    def __init__(self):
-        from importlib_resources import files
-
-        self.config_file = files("AstroToolkit.Configuration").joinpath("ATKConfig.ini")
-        if not os.path.isfile(self.config_file):
-            print("No ATKConfig.ini found. Making new one with default values\n")
-            self.set_default_config()
-            self.write_config()
-
-    @property
-    def supported_keys(self):
-        keys = []
-        for key, val in vars(self).items():
-            if key != "config_file":
-                keys.append(key)
-        return keys
-
-    def set_default_config(self):
-        from ..Data.dataquery import SurveyInfo
-
-        overlay_info = SurveyInfo().overlay_param_names
-
-        self.enable_notifications = "True"
-        self.query_data_radius = "3"
-        self.query_phot_radius = "3"
-        self.query_bulkphot_radius = "3"
-        self.query_lightcurve_radius = "3"
-        self.query_spectrum_radius = "3"
-        self.query_sed_radius = "3"
-        self.query_reddening_radius = "5"
-        self.query_image_size = "30"
-        self.query_image_overlays = "gaia"
-        self.query_image_band = "g"
-        self.query_lightcurve_atlas_username = "None"
-        self.query_lightcurve_atlas_password = "None"
-        self.unit_size = "400"
-        self.search_radius = "3"
-        self.datapage_search_button_radius = "3"
-        self.gaia_overlay_mag = overlay_info["gaia"]["default_overlay_mag"]
-        self.galex_overlay_mag = overlay_info["galex"]["default_overlay_mag"]
-        self.wise_overlay_mag = overlay_info["wise"]["default_overlay_mag"]
-        self.sdss_overlay_mag = overlay_info["sdss"]["default_overlay_mag"]
-        self.twomass_overlay_mag = overlay_info["twomass"]["default_overlay_mag"]
-        self.skymapper_overlay_mag = overlay_info["skymapper"]["default_overlay_mag"]
-        self.panstarrs_overlay_mag = overlay_info["panstarrs"]["default_overlay_mag"]
-        self.datapage_datatable_radius = "3"
-        self.datapage_grid_size = "250"
-        self.output_backend = "canvas"
-        self.font_size = "12"
-        self.font = "Times New Roman"
-        self.overlay_piggyback_radius = "5"
-
-    def read_config(self):
-        Config = configparser.ConfigParser()
-        Config.read(self.config_file)
-
-        sections = []
-        sections.append(Config["global_settings"])
-        sections.append(Config["query_settings"])
-        sections.append(Config["image_overlay_settings"])
-        sections.append(Config["search_settings"])
-        sections.append(Config["datapage_settings"])
-
-        for section in sections:
-            for key, val in section.items():
-                setattr(self, key, val)
-
-    def write_config(self):
-        config = configparser.ConfigParser()
-
-        config.add_section("global_settings")
-        config.set("global_settings", "enable_notifications", self.enable_notifications)
-        config.set("global_settings", "unit_size", self.unit_size)
-        config.set("global_settings", "output_backend", self.output_backend)
-        config.set("global_settings", "font_size", self.font_size)
-        config.set("global_settings", "font", self.font)
-
-        config.add_section("query_settings")
-        config.set("query_settings", "query_data_radius", self.query_data_radius)
-        config.set("query_settings", "query_phot_radius", self.query_phot_radius)
-        config.set(
-            "query_settings", "query_bulkphot_radius", self.query_bulkphot_radius
-        )
-        config.set(
-            "query_settings", "query_lightcurve_radius", self.query_lightcurve_radius
-        )
-        config.set(
-            "query_settings", "query_spectrum_radius", self.query_spectrum_radius
-        )
-        config.set("query_settings", "query_sed_radius", self.query_sed_radius)
-        config.set(
-            "query_settings", "query_reddening_radius", self.query_reddening_radius
-        )
-        config.set("query_settings", "query_image_size", self.query_image_size)
-        config.set("query_settings", "query_image_overlays", self.query_image_overlays)
-        config.set("query_settings", "query_image_band", self.query_image_band)
-        config.set(
-            "query_settings",
-            "query_lightcurve_atlas_username",
-            self.query_lightcurve_atlas_username,
-        )
-        config.set(
-            "query_settings",
-            "query_lightcurve_atlas_password",
-            self.query_lightcurve_atlas_password,
-        )
-
-        config.add_section("image_overlay_settings")
-        config.set("image_overlay_settings", "gaia_overlay_mag", self.gaia_overlay_mag)
-        config.set(
-            "image_overlay_settings", "galex_overlay_mag", self.galex_overlay_mag
-        )
-        config.set("image_overlay_settings", "wise_overlay_mag", self.wise_overlay_mag)
-        config.set("image_overlay_settings", "sdss_overlay_mag", self.sdss_overlay_mag)
-        config.set(
-            "image_overlay_settings", "twomass_overlay_mag", self.twomass_overlay_mag
-        )
-        config.set(
-            "image_overlay_settings",
-            "skymapper_overlay_mag",
-            self.skymapper_overlay_mag,
-        )
-        config.set(
-            "image_overlay_settings",
-            "panstarrs_overlay_mag",
-            self.panstarrs_overlay_mag,
-        )
-        config.set(
-            "image_overlay_settings",
-            "overlay_piggyback_radius",
-            self.overlay_piggyback_radius,
-        )
-
-        config.add_section("search_settings")
-        config.set("search_settings", "search_radius", self.search_radius)
-
-        config.add_section("datapage_settings")
-        config.set(
-            "datapage_settings",
-            "datapage_search_button_radius",
-            self.datapage_search_button_radius,
-        )
-        config.set(
-            "datapage_settings",
-            "datapage_datatable_radius",
-            self.datapage_datatable_radius,
-        )
-        config.set("datapage_settings", "datapage_grid_size", self.datapage_grid_size)
-
-        with open(self.config_file, "w") as file:
-            config.write(file)
-
-    def edit_config(self, key, value):
-        self.read_config()
-        if not isinstance(value, str):
-            try:
-                value = str(value)
-            except:
-                raise Exception("ATKConfig.ini options must be strings.")
-        setattr(self, key, value)
-        self.write_config()
-
-        self.output_config()
-
-    def output_config(self):
-        self.read_config()
-        for key, val in vars(self).items():
-            if key != "config_file":
-                print(f"{key} = {val}")
+import configparser
+import os
+
+
+class ConfigStruct(object):
+    def __init__(self):
+        from importlib_resources import files
+
+        self.config_file = files("AstroToolkit.Configuration").joinpath("ATKConfig.ini")
+        if not os.path.isfile(self.config_file):
+            print("No ATKConfig.ini found. Making new one with default values\n")
+            self.set_default_config()
+            self.write_config()
+
+    @property
+    def supported_keys(self):
+        keys = []
+        for key, val in vars(self).items():
+            if key != "config_file":
+                keys.append(key)
+        return keys
+
+    def set_default_config(self):
+        from ..Data.dataquery import SurveyInfo
+
+        overlay_info = SurveyInfo().overlay_param_names
+
+        self.enable_notifications = "True"
+        self.query_data_radius = "3"
+        self.query_phot_radius = "3"
+        self.query_bulkphot_radius = "3"
+        self.query_lightcurve_radius = "3"
+        self.query_spectrum_radius = "3"
+        self.query_sed_radius = "3"
+        self.query_reddening_radius = "5"
+        self.query_image_size = "30"
+        self.query_image_overlays = "gaia"
+        self.query_image_band = "g"
+        self.query_lightcurve_atlas_username = "None"
+        self.query_lightcurve_atlas_password = "None"
+        self.unit_size = "400"
+        self.search_radius = "3"
+        self.datapage_search_button_radius = "3"
+        self.gaia_overlay_mag = overlay_info["gaia"]["default_overlay_mag"]
+        self.galex_overlay_mag = overlay_info["galex"]["default_overlay_mag"]
+        self.wise_overlay_mag = overlay_info["wise"]["default_overlay_mag"]
+        self.sdss_overlay_mag = overlay_info["sdss"]["default_overlay_mag"]
+        self.twomass_overlay_mag = overlay_info["twomass"]["default_overlay_mag"]
+        self.skymapper_overlay_mag = overlay_info["skymapper"]["default_overlay_mag"]
+        self.panstarrs_overlay_mag = overlay_info["panstarrs"]["default_overlay_mag"]
+        self.datapage_datatable_radius = "3"
+        self.datapage_grid_size = "250"
+        self.output_backend = "canvas"
+        self.font_size = "12"
+        self.font = "Times New Roman"
+        self.overlay_piggyback_radius = "5"
+
+    def read_config(self):
+        Config = configparser.ConfigParser()
+        Config.read(self.config_file)
+
+        sections = []
+        sections.append(Config["global_settings"])
+        sections.append(Config["query_settings"])
+        sections.append(Config["image_overlay_settings"])
+        sections.append(Config["search_settings"])
+        sections.append(Config["datapage_settings"])
+
+        for section in sections:
+            for key, val in section.items():
+                setattr(self, key, val)
+
+    def write_config(self):
+        config = configparser.ConfigParser()
+
+        config.add_section("global_settings")
+        config.set("global_settings", "enable_notifications", self.enable_notifications)
+        config.set("global_settings", "unit_size", self.unit_size)
+        config.set("global_settings", "output_backend", self.output_backend)
+        config.set("global_settings", "font_size", self.font_size)
+        config.set("global_settings", "font", self.font)
+
+        config.add_section("query_settings")
+        config.set("query_settings", "query_data_radius", self.query_data_radius)
+        config.set("query_settings", "query_phot_radius", self.query_phot_radius)
+        config.set(
+            "query_settings", "query_bulkphot_radius", self.query_bulkphot_radius
+        )
+        config.set(
+            "query_settings", "query_lightcurve_radius", self.query_lightcurve_radius
+        )
+        config.set(
+            "query_settings", "query_spectrum_radius", self.query_spectrum_radius
+        )
+        config.set("query_settings", "query_sed_radius", self.query_sed_radius)
+        config.set(
+            "query_settings", "query_reddening_radius", self.query_reddening_radius
+        )
+        config.set("query_settings", "query_image_size", self.query_image_size)
+        config.set("query_settings", "query_image_overlays", self.query_image_overlays)
+        config.set("query_settings", "query_image_band", self.query_image_band)
+        config.set(
+            "query_settings",
+            "query_lightcurve_atlas_username",
+            self.query_lightcurve_atlas_username,
+        )
+        config.set(
+            "query_settings",
+            "query_lightcurve_atlas_password",
+            self.query_lightcurve_atlas_password,
+        )
+
+        config.add_section("image_overlay_settings")
+        config.set("image_overlay_settings", "gaia_overlay_mag", self.gaia_overlay_mag)
+        config.set(
+            "image_overlay_settings", "galex_overlay_mag", self.galex_overlay_mag
+        )
+        config.set("image_overlay_settings", "wise_overlay_mag", self.wise_overlay_mag)
+        config.set("image_overlay_settings", "sdss_overlay_mag", self.sdss_overlay_mag)
+        config.set(
+            "image_overlay_settings", "twomass_overlay_mag", self.twomass_overlay_mag
+        )
+        config.set(
+            "image_overlay_settings",
+            "skymapper_overlay_mag",
+            self.skymapper_overlay_mag,
+        )
+        config.set(
+            "image_overlay_settings",
+            "panstarrs_overlay_mag",
+            self.panstarrs_overlay_mag,
+        )
+        config.set(
+            "image_overlay_settings",
+            "overlay_piggyback_radius",
+            self.overlay_piggyback_radius,
+        )
+
+        config.add_section("search_settings")
+        config.set("search_settings", "search_radius", self.search_radius)
+
+        config.add_section("datapage_settings")
+        config.set(
+            "datapage_settings",
+            "datapage_search_button_radius",
+            self.datapage_search_button_radius,
+        )
+        config.set(
+            "datapage_settings",
+            "datapage_datatable_radius",
+            self.datapage_datatable_radius,
+        )
+        config.set("datapage_settings", "datapage_grid_size", self.datapage_grid_size)
+
+        with open(self.config_file, "w") as file:
+            config.write(file)
+
+    def edit_config(self, key, value):
+        self.read_config()
+        if not isinstance(value, str):
+            try:
+                value = str(value)
+            except:
+                raise Exception("ATKConfig.ini options must be strings.")
+        setattr(self, key, value)
+        self.write_config()
+
+        self.output_config()
+
+    def output_config(self):
+        self.read_config()
+        for key, val in vars(self).items():
+            if key != "config_file":
+                print(f"{key} = {val}")