diff --git a/docs/conf.py b/docs/conf.py index a72bdf7..cbd8c5a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,7 @@ sys.path.insert(0, os.path.abspath("../../src/")) sys.path.insert(0, os.path.abspath("../../src/tssc")) -project = "Timeseries Simple Search Combo (tssc)" +project = "lksearch" copyright = "2024, TESS Science Support Center" author = "TESS Science Support Center" release = "0.1.dev" @@ -46,8 +46,6 @@ "sphinx_automodapi.automodapi", "numpydoc", "sphinx.ext.intersphinx", - "myst_parser", - # "pandoc", ] templates_path = ["_templates"] diff --git a/pyproject.toml b/pyproject.toml index a3a966c..6eff1df 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [tool.poetry] -name = "tssc" +name = "lksearch" version = "0.1.0" -description = "Helpful package to search for TESS/Kepler/K2 data" +description = "A helpful little package to search for TESS/Kepler/K2 data" authors = ["TESS SCience Support Center "] license = "MIT" readme = "README.md" @@ -25,7 +25,6 @@ pytest = "^7.4.4" nbsphinx = "^0.9.3" sphinx = "^7.3.7" sphinx_rtd_theme = "^2.0.0" -myst_parser = "^3.0.0" sphinx_astropy = "^1.9.1" sphinx_automodapi = "^0.17.0" diff --git a/src/tssc/K2Search.py b/src/lksearch/K2Search.py similarity index 100% rename from src/tssc/K2Search.py rename to src/lksearch/K2Search.py diff --git a/src/tssc/KeplerSearch.py b/src/lksearch/KeplerSearch.py similarity index 100% rename from src/tssc/KeplerSearch.py rename to src/lksearch/KeplerSearch.py diff --git a/src/tssc/MASTSearch.py b/src/lksearch/MASTSearch.py similarity index 100% rename from src/tssc/MASTSearch.py rename to src/lksearch/MASTSearch.py diff --git a/src/tssc/TESSSearch.py b/src/lksearch/TESSSearch.py similarity index 100% rename from src/tssc/TESSSearch.py rename to src/lksearch/TESSSearch.py diff --git a/src/tssc/__init__.py b/src/lksearch/__init__.py similarity index 93% rename from src/tssc/__init__.py rename to src/lksearch/__init__.py index 078c68f..b3daefa 100644 --- a/src/tssc/__init__.py +++ b/src/lksearch/__init__.py @@ -28,7 +28,7 @@ class Conf(_config.ConfigNamespace): List of extra columns to be included when displaying a SearchResult object. cache_dir - Default cache directory for data files downloaded, etc. Defaults to ``~/.tssc/cache`` if not specified. + Default cache directory for data files downloaded, etc. Defaults to ``~/.lksearch/cache`` if not specified. """ @@ -42,14 +42,14 @@ class Conf(_config.ConfigNamespace): [], "List of extra columns to be included when displaying a SearchResult object.", cfgtype="string_list", - module="tssc.search", + module="lksearch.search", ) cache_dir = _config.ConfigItem( None, "Default cache directory for data files downloaded, etc.", cfgtype="string", - module="tssc.config", + module="lksearch.config", ) diff --git a/src/tssc/config/__init__.py b/src/lksearch/config/__init__.py similarity index 87% rename from src/tssc/config/__init__.py rename to src/lksearch/config/__init__.py index 96fe96d..cd631f4 100644 --- a/src/tssc/config/__init__.py +++ b/src/lksearch/config/__init__.py @@ -6,7 +6,7 @@ import astropy.config as astropyconfig -ROOTNAME = "tssc" +ROOTNAME = "lksearch" PREFER_CLOUD = True # Do you prefer URIs pointing to the Amazon bucket when available? DOWNLOAD_CLOUD = True @@ -24,9 +24,9 @@ def get_config_dir(): Determines the package configuration directory name and creates the directory if it doesn't exist. - This directory is typically ``$HOME/.tssc/config``, but if the + This directory is typically ``$HOME/.lksearch/config``, but if the XDG_CONFIG_HOME environment variable is set and the - ``$XDG_CONFIG_HOME/tssc`` directory exists, it will be that directory. + ``$XDG_CONFIG_HOME/lksearch`` directory exists, it will be that directory. If neither exists, the former will be created and symlinked to the latter. Returns @@ -40,13 +40,13 @@ def get_config_dir(): def get_cache_dir(): """ - Determines the default TSSC cache directory name and creates the + Determines the default lksearch cache directory name and creates the directory if it doesn't exist. If the directory cannot be access or created, then it returns the current directory (``"."``). - This directory is typically ``$HOME/.tssc/cache``, but if the + This directory is typically ``$HOME/.lksearch/cache``, but if the XDG_CACHE_HOME environment variable is set and the - ``$XDG_CACHE_HOME/tssc`` directory exists, it will be that directory. + ``$XDG_CACHE_HOME/lksearch`` directory exists, it will be that directory. If neither exists, the former will be created and symlinked to the latter. The value can be also configured via ``cache_dir`` configuration parameter. diff --git a/src/tssc/data/short_cadence_month_lookup.csv b/src/lksearch/data/short_cadence_month_lookup.csv similarity index 100% rename from src/tssc/data/short_cadence_month_lookup.csv rename to src/lksearch/data/short_cadence_month_lookup.csv diff --git a/src/tssc/utils.py b/src/lksearch/utils.py similarity index 100% rename from src/tssc/utils.py rename to src/lksearch/utils.py diff --git a/src/tssc/version.py b/src/lksearch/version.py similarity index 100% rename from src/tssc/version.py rename to src/lksearch/version.py diff --git a/tests/test_search.py b/tests/test_search.py index 5457a5f..9a0863a 100644 --- a/tests/test_search.py +++ b/tests/test_search.py @@ -18,9 +18,9 @@ import shutil -from tssc.utils import SearchError, SearchWarning +from lksearch.utils import SearchError, SearchWarning -from tssc import MASTSearch, TESSSearch, KeplerSearch, K2Search +from lksearch import MASTSearch, TESSSearch, KeplerSearch, K2Search def test_search_cubedata():