AstroToolkit 1.6.3__tar.gz → 1.7.0__tar.gz

astrotoolkit-1.7.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include src/AstroToolkit/Examples/*.fits
+include src/AstroToolkit/Examples/*.txt
+include src/AstroToolkit/Plotting/*.fits

{astrotoolkit-1.6.3/src/AstroToolkit.egg-info → astrotoolkit-1.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: AstroToolkit
-Version: 1.6.3
+Version: 1.7.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
@@ -25,6 +25,7 @@ Requires-Dist: selenium==4.21.0
 Requires-Dist: lightkurve==2.4.2
 Requires-Dist: PyQt5==5.15.10
 Requires-Dist: numba==0.60.0
+Dynamic: license-file
 
 AstroToolkit
 ============
@@ -38,7 +39,6 @@ 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
@@ -46,7 +46,7 @@ Features
 * 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, ...)
+    * Timeseries analysis
     * Light curve binning, clipping, phase folding and sigma-clipping
     * Image detection and tracer overlays
     * Spectral band highlighting
@@ -60,7 +60,27 @@ Features
 
 <br>
 
+Acknowledgements
+----------------
+This project has received funding from the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (Grant agreement No. 101020057).
+
+<p align="center">
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="./docs/images/erc_logo_dark.png">
+        <source media="(prefers-color-scheme: light)" srcset="./docs/images/erc_logo_light.png">
+        <img src="./images/erc_logo_dark.png" width="200"/>
+    </picture>
+</p>
+
+<br>
+
+I would like to give thanks to Dr. Keith Inight for his guidance at various stages of the package's development.
+
+I would also like to give thanks to Prof. Boris Gänsicke for his assistance and guidance, and for supporting the package's development.
+
+<br>
+
 Documentation
 -------------
 
-Full documentation for the package can be found [here](https://astrotoolkit.readthedocs.io/en/latest/). 
+Full documentation for the package can be found [here](https://astrotoolkit.readthedocs.io/en/latest/).

{astrotoolkit-1.6.3 → astrotoolkit-1.7.0}/README.md

@@ -10,7 +10,6 @@ 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
@@ -18,7 +17,7 @@ Features
 * 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, ...)
+    * Timeseries analysis
     * Light curve binning, clipping, phase folding and sigma-clipping
     * Image detection and tracer overlays
     * Spectral band highlighting
@@ -32,7 +31,27 @@ Features
 
 <br>
 
+Acknowledgements
+----------------
+This project has received funding from the European Research Council (ERC) under the European Union’s Horizon 2020 research and innovation programme (Grant agreement No. 101020057).
+
+<p align="center">
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="./docs/images/erc_logo_dark.png">
+        <source media="(prefers-color-scheme: light)" srcset="./docs/images/erc_logo_light.png">
+        <img src="./images/erc_logo_dark.png" width="200"/>
+    </picture>
+</p>
+
+<br>
+
+I would like to give thanks to Dr. Keith Inight for his guidance at various stages of the package's development.
+
+I would also like to give thanks to Prof. Boris Gänsicke for his assistance and guidance, and for supporting the package's development.
+
+<br>
+
 Documentation
 -------------
 
-Full documentation for the package can be found [here](https://astrotoolkit.readthedocs.io/en/latest/). 
+Full documentation for the package can be found [here](https://astrotoolkit.readthedocs.io/en/latest/).

{astrotoolkit-1.6.3 → astrotoolkit-1.7.0}/pyproject.toml

@@ -1,48 +1,56 @@
-[build-system]
-requires = ["setuptools"]
-build-backend = "setuptools.build_meta"
-
-[tool.setuptools]
-include-package-data = true
-
-[project]
-name = "AstroToolkit"
-version = "1.6.3"
-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"
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.black]
+line-length=120
+skip-magic-trailing-comma = true
+
+[project]
+name = "AstroToolkit"
+version = "1.7.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"
+ATKquery = "bin.atkquery_command:main"
+ATKread = "bin.atkread_command:main"
+ATKsearch = "bin.atksearch_command:main"
+ATKconv = "bin.atkconv_command:main"
+ATKconfig = "bin.atkconfig_command:main"
+ATKalias = "bin.atkalias_command:main"
+ATKepoch = "bin.atkepoch_command:main"
+ATKoverlay = "bin.atkoverlay_command:main"

astrotoolkit-1.7.0/src/AstroToolkit/Aliases.py

@@ -0,0 +1,110 @@
+"""
+ATK supports the creation of aliases to any Vizier catalogue, which are set via an aliases file. This module allows the aliases file to be viewed and edited.
+"""
+
+from .Configuration.catalogue_setup import CatalogueStruct
+from .Input.input_validation import check_inputs
+
+catalogues = CatalogueStruct()
+catalogues.get_catalogues()
+
+
+def addAlias(name: str, id: str) -> None:
+    """addAlias(name,id)
+    Adds a Vizier catalogue alias to ATK for use in data queries.
+
+    :param name: alias name, e.g. 'allwise'
+    :type name: str
+    :param id: Vizier catalogue ID, e.g. 'II/328/allwise'
+    :type id: str
+
+    :return: None
+
+    |
+
+    """
+
+    corrected_inputs = check_inputs({"name": [name, str], "id": [id, str]}, "addAlias")
+    name, id = corrected_inputs
+
+    catalogues.add_catalogue(name, id)
+    print(f"Added alias for {id} with label {name}.")
+
+    return None
+
+
+def delAlias(name: str) -> None:
+    """delAlias(name)
+    Deletes an existing catalogue alias.
+
+    :param name: alias name to be deleted
+    :type name: str
+
+    :return: None
+
+    |
+
+    """
+
+    corrected_inputs = check_inputs({"name": [name, str]}, "delAlias")
+    name = corrected_inputs[0]
+
+    catalogues.delete_catalogue(name)
+    print(f"Deleted alias with label {name}.")
+
+
+def openAliases() -> None:
+    """openAliases()
+    Opens the catalogue alias list in the default text editor.
+
+    :return: None
+
+    |
+
+    """
+    catalogues = CatalogueStruct()
+    path = catalogues.catalogue_file
+
+    import platform
+    import subprocess
+
+    if platform.system().lower() in ["posix", "linux"]:
+        subprocess.run(["chmod", "+x", str(path)])
+        subprocess.run(["xdg-open", str(path)])
+    else:
+        import webbrowser
+
+        webbrowser.open(path)
+
+    return None
+
+
+def resetAliases() -> None:
+    """resetAliases()
+    Resets the catalogue alias list (i.e. only keeps default ATK data surveys).
+
+    :return: None
+
+    |
+
+    """
+    print("Resetting ATKAliases.ini to default values...\n")
+    catalogues.default_setup()
+
+    return None
+
+
+def showAliases() -> None:
+    """showAliases()
+    Prints the current catalogue alias list to stdout.
+
+    :return: None
+
+    |
+
+    """
+    print("Current ATKAliases.ini values:\n")
+    catalogues.get_catalogues()
+    catalogues.output_catalogues()
+
+    return None

astrotoolkit-1.7.0/src/AstroToolkit/Config.py

@@ -0,0 +1,93 @@
+"""
+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
+from .Input.input_validation import check_inputs
+
+config = ConfigStruct()
+config.read_config()
+
+
+def editConfig(key: str, value: str) -> None:
+    """editConfig(key, value)
+    Edits config values. See :ref:`Config Keys` for a list and description of available keys.
+
+    :param key: config key
+    :type key: str
+    :param value: value to assign to this config key
+    :type value: str
+
+    :return: None
+
+    |
+
+    """
+
+    corrected_inputs = check_inputs(
+        {"key": [key, str], "value": [value, str]}, "editconfig"
+    )
+    key, value = corrected_inputs
+
+    print("Written change to ATKConfig.ini. New Values:\n")
+    config.edit_config(key, value)
+
+    return None
+
+
+def openConfig() -> None:
+    """openConfig()
+    Opens the config in the default text editor. See :ref:`Config Keys` for a list and description of available keys.
+
+    :return: None
+
+    |
+
+    """
+    config = ConfigStruct()
+    path = config.config_file
+
+    import platform
+    import subprocess
+
+    if platform.system().lower() in ["posix", "linux"]:
+        subprocess.run(["chmod", "+x", str(path)])
+        subprocess.run(["xdg-open", str(path)])
+    else:
+        import webbrowser
+
+        webbrowser.open(path)
+
+    return None
+
+
+def showConfig() -> None:
+    """showConfig()
+    Prints the current config file to stdout.
+
+    :return: None
+
+    |
+
+    """
+    print("Current ATKConfig.ini values:\n")
+    config.read_config()
+    config.output_config()
+
+    return None
+
+
+def resetConfig() -> None:
+    """resetConfig()
+    Resets the config to default values. A list of available keys and their default values can be found in :ref:`Config Keys`.
+
+    :return: None
+
+    |
+
+    """
+    print("Resetting ATKConfig.ini to default values...\n")
+    config.set_default_config()
+    config.write_config()
+
+    return None