exoclock 1.0.0__tar.gz

exoclock-1.0.0/MANIFEST.in

@@ -0,0 +1,12 @@
+include exoclock/catalogues/*
+include exoclock/processes/*
+include exoclock/spacetime/*
+include exoclock/__author__.txt
+include exoclock/__author_email__.txt
+include exoclock/__databases__.pickle
+include exoclock/__description__.txt
+include exoclock/__url__.txt
+include exoclock/__version__.txt
+include README.md 
+include LICENSE
+include requirements.txt

exoclock-1.0.0/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.1
+Name: exoclock
+Version: 1.0.0
+Summary: A python package for programmatic interaction with the ExoClock project archives.
+Home-page: https://github.com/atsiaras/exoclock
+Author: Angelos Tsiaras
+Author-email: aggelostsiaras@gmail.com
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Astronomy
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python :: 3.8
+
+Visit https://github.com/atsiaras/exoclock for more details.

exoclock-1.0.0/README.md

@@ -0,0 +1,12 @@
+[![Build Python 3.8](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.8.yml/badge.svg)](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.8.yml)
+[![Build Python 3.9](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.9.yml/badge.svg)](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.9.yml)
+[![Build Python 3.10](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.10.yml/badge.svg)](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.10.yml)
+[![Build Python 3.11](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.11.yml/badge.svg)](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.11.yml)
+[![Build Python 3.12](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.12.yml/badge.svg)](https://github.com/atsiaras/exoclock/actions/workflows/build-python-3.12.yml)
+
+[![codecov](https://codecov.io/gh/atsiaras/exoclock/graph/badge.svg?token=L514113T7U)](https://codecov.io/gh/atsiaras/exoclock)
+
+# exoclock
+A python package to connect with the [ExoClock Project](https://www.exoclock.space) ([Kokori et al. 2022](https://link.springer.com/article/10.1007/s10686-020-09696-3)).
+
+<img src="https://www.exoclock.space/static/logo.png" width="25%">

exoclock-1.0.0/exoclock/__author__.txt

@@ -0,0 +1 @@
+Angelos Tsiaras

exoclock-1.0.0/exoclock/__author_email__.txt

@@ -0,0 +1 @@
+aggelostsiaras@gmail.com

exoclock-1.0.0/exoclock/__databases_setup__.py

@@ -0,0 +1,182 @@
+
+import os
+import time
+import shutil
+
+from .processes.files import open_dict, download
+
+try:
+    import zipfile
+    download_zip = True
+except:
+    download_zip = False
+
+
+def _setup_database(package_data, database_name):
+
+        print('exoclock: Checking {0} database...'.format(database_name))
+
+        # define paths
+
+        database_directory_path = os.path.join(package_data.databases_directory_path, database_name)
+        database_file_path = os.path.join(package_data.databases_directory_path, database_name + '.pickle')
+        database_link_file_path = os.path.join(package_data.databases_directory_path, database_name + '_link.txt')
+        database_file_path_new = os.path.join(package_data.databases_directory_path, database_name + '_new.pickle')
+        database_file_path_old = os.path.join(package_data.databases_directory_path, database_name + '_old.pickle')
+        last_update_file_path = os.path.join(package_data.databases_directory_path, '{0}_last_update.txt'.format(database_name))
+
+        # define paths
+
+        # check if everything exists, if not reset database
+
+        if not os.path.isdir(database_directory_path) or not os.path.isfile(database_file_path) or not os.path.isfile(database_link_file_path):
+
+            try:
+                shutil.rmtree(database_directory_path)
+            except:
+                pass
+
+            try:
+                os.remove(database_file_path)
+            except:
+                pass
+
+            try:
+                os.remove(database_file_path_old)
+            except:
+                pass
+
+            try:
+                os.remove(database_file_path_new)
+            except:
+                pass
+
+            try:
+                os.remove(database_link_file_path)
+            except:
+                pass
+
+            try:
+                os.remove(last_update_file_path)
+            except:
+                pass
+
+            os.mkdir(database_directory_path)
+
+
+            print(package_data.databases[package_data.version][database_name], database_file_path)
+
+            if not download(package_data.databases[package_data.version][database_name], database_file_path):
+                print('\n{0} features cannot be used.'.format(database_name))
+                return False
+            else:
+                shutil.copy(database_file_path, database_file_path_old)
+                w = open(database_link_file_path, 'w')
+                w.write(package_data.databases[package_data.version][database_name])
+                w.close()
+
+                try:
+                    new_database = open_dict(database_file_path)
+                    download(new_database['zipfile'], database_directory_path + '.zip')
+                    new_database = zipfile.ZipFile(database_directory_path + '.zip', 'r')
+                    here = os.path.abspath('.')
+                    os.chdir(package_data.databases_directory_path)
+                    new_database.extractall()
+                    os.chdir(here)
+                    os.remove(database_directory_path + '.zip')
+                except:
+                    pass
+
+        # check if everything exists, if not reset database
+
+        # download database if there is an update
+
+        if package_data.databases[package_data.version][database_name] != open(database_link_file_path).read():
+
+            if not download(package_data.databases[package_data.version][database_name], database_file_path_new):
+                pass
+            else:
+                shutil.move(database_file_path, database_file_path_old)
+                shutil.move(database_file_path_new, database_file_path)
+
+                w = open(database_link_file_path, 'w')
+                w.write(package_data.databases[package_data.version][database_name])
+                w.close()
+
+        # download database if there is an update
+
+        # check all files in database, remove files that need to be updated
+
+        current_database = open_dict(database_file_path_old)
+        new_database = open_dict(database_file_path)
+
+        for dbx_file in current_database['files']:
+
+            if dbx_file not in new_database['files']:
+                try:
+                    os.remove(os.path.join(package_data.databases_directory_path,
+                                           new_database['files'][dbx_file]['local_path']))
+                except:
+                    pass
+            elif new_database['files'][dbx_file]['link'] != current_database['files'][dbx_file]['link']:
+                try:
+                    os.remove(os.path.join(package_data.databases_directory_path,
+                                           new_database['files'][dbx_file]['local_path']))
+                except:
+                    pass
+
+        # check for updates, remove files that need to be updated
+
+        # download missing files
+
+        final_check = True
+
+        for dbx_file in new_database['files']:
+            if not os.path.isfile(os.path.join(package_data.databases_directory_path,
+                                               new_database['files'][dbx_file]['local_path'])):
+                try:
+                    os.remove(last_update_file_path)
+                except:
+                    pass
+                if not download(new_database['files'][dbx_file]['link'],
+                                os.path.join(package_data.databases_directory_path,
+                                             new_database['files'][dbx_file]['local_path'])):
+                    final_check = False
+
+        # download missing files
+
+        # update files from external links
+
+        frequency = new_database['frequency']
+        if frequency:
+
+            try:
+                last_update_date = int(open(last_update_file_path).read())
+            except:
+                last_update_date = 0
+
+            today = int(time.strftime('%y%m%d'))
+
+            if today >= last_update_date + frequency:
+
+                for dbx_file in new_database['files']:
+                    if 'external_link' in new_database['files'][dbx_file]:
+                        print('\tUpdating: ', dbx_file)
+                        if not download(new_database['files'][dbx_file]['external_link'],
+                                        os.path.join(package_data.databases_directory_path,
+                                                     new_database['files'][dbx_file]['local_path'])):
+                            final_check = False
+
+                w = open(last_update_file_path, 'w')
+                w.write(time.strftime('%y%m%d'))
+                w.close()
+
+        # update files from external links
+
+        if not final_check:
+            print('\n{0} features cannot be used.'.format(database_name))
+            return False
+        else:
+            if current_database != new_database:
+                shutil.copy(database_file_path, database_file_path_old)
+            return database_directory_path

exoclock-1.0.0/exoclock/__description__.txt

@@ -0,0 +1 @@
+A python package for programmatic interaction with the ExoClock project archives.

exoclock-1.0.0/exoclock/__init__.py

@@ -0,0 +1,20 @@
+import os
+
+__version__ = open(os.path.join(os.path.abspath(os.path.dirname(__file__)), '__version__.txt')).read()
+__author__ = open(os.path.join(os.path.abspath(os.path.dirname(__file__)), '__author__.txt')).read()
+__author_email__ = open(os.path.join(os.path.abspath(os.path.dirname(__file__)), '__author_email__.txt')).read()
+__description__ = open(os.path.join(os.path.abspath(os.path.dirname(__file__)), '__description__.txt')).read()
+__url__ = open(os.path.join(os.path.abspath(os.path.dirname(__file__)), '__url__.txt')).read()
+
+from .catalogues.catalogues import *
+from .catalogues.simbad import *
+
+from .spacetime.angles import *
+from .spacetime.moments import *
+from .spacetime.observatories import *
+from .spacetime.targets import *
+
+from .processes.files import *
+
+from .errors import *
+from .databases import *

exoclock-1.0.0/exoclock/__url__.txt

@@ -0,0 +1 @@
+https://github.com/atsiaras/exoclock

exoclock-1.0.0/exoclock/__version__.txt

@@ -0,0 +1 @@
+1.0.0

exoclock-1.0.0/exoclock/catalogues/catalogues.py

@@ -0,0 +1,121 @@
+
+__all__ = ['get_planet', 'get_system', 'get_all_planets', 'locate_planet', 'locate_system', 'get_all_planets']
+
+import numpy as np
+
+
+from .simbad import simbad_search_by_name
+
+from ..spacetime.angles import *
+from ..spacetime.angles import _request_angle, _reformat_or_request_angle
+from ..spacetime.targets import *
+from ..databases import exoclock_data
+from ..errors import *
+
+
+def _flat_name(name):
+
+    flat_name_list = [
+        [' ', ''],
+        ['-', ''],
+        ['cancri', 'cnc'],
+        ['hatp10', 'wasp11'],
+        ['wasp40', 'hatp27'],
+        ['wasp51', 'hatp30'],
+        ['wasp86', 'kelt12'],
+        ['kelt22', 'wasp173'],
+    ]
+
+    name = name.lower()
+
+    for char in flat_name_list:
+        name = name.replace(char[0], char[1])
+
+    return name
+
+
+def _search_by_planet(name):
+
+    planets = exoclock_data.ecc()['planets']
+
+    name_or = name
+
+    if name in planets:
+        return name
+
+    else:
+        for i in planets:
+            if _flat_name(i) == _flat_name(name):
+                return str(i)
+            elif (_flat_name(i)[-1] == _flat_name(name)[-1] and _flat_name(i)[:-2] == _flat_name(name)[:-1] and
+                  _flat_name(i)[-2] in ['a', 'b', 'n']):
+                return str(i)
+
+    raise ExoClockInputError('No planet {0} found in the catalogue.'.format(name_or))
+
+
+def get_all_planets():
+
+    return list(exoclock_data.ecc()['planets'].keys())
+
+
+def get_planet(name):
+
+    name = _search_by_planet(name)
+
+    planet_data = exoclock_data.ecc()['planets'][name]
+    star_data = exoclock_data.ecc()['stars'][planet_data['star']]
+    star_data['ra_deg'] = Hours(star_data['ra']).deg()
+    star_data['dec_deg'] = Degrees(star_data['dec']).deg_coord()
+
+    return {'name': name, 'planet': planet_data, 'star': star_data}
+
+
+def get_system(star_name):
+
+    target = simbad_search_by_name(star_name)
+    if not target:
+        return []
+
+    test = list(set(target.all_names).intersection(list(exoclock_data.ecc()['hosts'])))
+
+    if len(test) == 0:
+        return []
+
+    planets = exoclock_data.ecc()['hosts'][test[0]]
+
+    return [get_planet(planet) for planet in planets]
+
+
+def locate_planet(ra, dec, radius=Degrees(0.02), observation_time=None, observation_type=None):
+
+    _request_angle(ra)
+    _request_angle(dec)
+    _request_angle(radius)
+
+    pointing = FixedTarget(ra, dec)
+
+    test_planets = []
+
+    for test_planet_name in get_all_planets():
+        test_planet = get_planet(test_planet_name)
+        test_planet = FixedTarget(Degrees(test_planet['star']['ra_deg']), Degrees(test_planet['star']['dec_deg']))
+        test_planets.append([pointing.distance_on_sphere(test_planet).deg(), test_planet_name])
+
+    test_planets.sort()
+
+    if test_planets[0][0] < radius.deg():
+        return get_planet(test_planets[0][1])
+    else:
+        raise ExoClockLibraryError('Planet could not be located')
+
+
+def locate_system(ra, dec, radius=0.02):
+
+    return get_system(locate_planet(ra, dec, radius)['star']['simbad_id'])
+
+
+def get_all_planets():
+    return list(exoclock_data.ecc()['planets'].keys())
+
+

exoclock-1.0.0/exoclock/catalogues/simbad.py

@@ -0,0 +1,152 @@
+__all__ = ['simbad_search_by_name', 'simbad_search_by_coordinates']
+
+import time
+import requests
+import warnings
+
+from astroquery.simbad import Simbad
+
+from ..spacetime.angles import *
+from ..spacetime.angles import _request_angle, _reformat_or_request_angle
+from ..spacetime.targets import *
+from ..databases import exoclock_data
+from ..errors import *
+
+Simbad = Simbad()
+Simbad.add_votable_fields('ids')
+
+
+def _flat_name(name):
+
+    flat_name_list = [
+        [' ', ''],
+        ['-', ''],
+        ['cancri', 'cnc'],
+        ['hatp10', 'wasp11'],
+        ['wasp40', 'hatp27'],
+        ['wasp51', 'hatp30'],
+        ['wasp86', 'kelt12'],
+        ['kelt22', 'wasp173'],
+    ]
+
+    name = name.lower()
+
+    for char in flat_name_list:
+        name = name.replace(char[0], char[1])
+
+    return name
+
+
+def _fix_simbad_name(input):
+
+    try:
+        input = input.decode("utf-8")
+    except:
+        pass
+
+    while '  ' in input:
+        input = input.replace('  ', ' ')
+
+    return input
+
+
+def _fix_simbad_coordinates(input):
+
+    input = str(input).replace(' ', ':')
+
+    if len(input.split(':')) == 1:
+        input += ':00:00'
+    elif len(input.split(':')) == 2:
+        input += ':00'
+
+    return input
+
+
+def simbad_search_by_name(star_name, max_trials=10):
+
+    try:
+        star = exoclock_data.ecc()['stars'][exoclock_data.ecc()['flats'][_flat_name(star_name)]]
+
+        return FixedTarget(
+            Hours(star['ra']),
+            Degrees(star['dec']),
+            star['simbad_id'],
+            [star['simbad_id']]
+        )
+
+    except KeyError:
+        pass
+
+    star_name = star_name.replace('HD-', 'HD ')
+    star_name = star_name.replace('HR-', 'HR ')
+    star_name = star_name.replace('2MASS-', '2MASS ')
+    star_name = star_name.replace('GJ-', 'GJ ')
+    star_name = star_name.replace('HIP-', 'HIP ')
+    star_name = star_name.replace('LHS-', 'LHS ')
+    star_name = star_name.replace('TYC-', 'TYC ')
+    star_name = star_name.replace('KIC-', 'KIC ')
+    star_name = star_name.replace('ADS-', 'ADS ')
+    star_name = star_name.replace('GSC-', 'GSC ')
+    star_name = star_name.replace('UCAC4-', 'UCAC4 ')
+
+    if 'BD' in star_name:
+        star_name = star_name[:3] + star_name[3:].replace('-', ' ')
+
+    result = None
+    connected = False
+    trials = 0
+    while not connected and trials < max_trials:
+        try:
+            with warnings.catch_warnings():
+                warnings.filterwarnings("ignore")
+                result = Simbad.query_object(star_name)
+                connected = True
+                time.sleep(0.1)
+        except requests.ConnectionError:
+            trials += 1
+
+    if result and len(result) > 0:
+
+        return FixedTarget(
+            Hours(_fix_simbad_coordinates(result[0]['RA'])),
+            Degrees(_fix_simbad_coordinates(result[0]['DEC'])),
+            _fix_simbad_name(result[0]['MAIN_ID']),
+            [_fix_simbad_name(ff) for ff in result[0]['IDS'].split('|')]
+        )
+    else:
+        print('No matches found or connection is down.')
+        return None
+
+
+def simbad_search_by_coordinates(ra, dec, radius=Degrees(0.02), max_trials=10):
+
+    _request_angle(ra)
+    _request_angle(dec)
+    _request_angle(radius)
+
+    target = FixedTarget(ra, dec)
+
+    result = None
+    connected = False
+    trials = 0
+    while not connected and trials < max_trials:
+        try:
+            with warnings.catch_warnings():
+                warnings.filterwarnings("ignore")
+                result = Simbad.query_region("{0}d {1}d".format(target.ra.deg(), target.dec.deg()),
+                                             radius='{0}d'.format(radius.deg()))
+                connected = True
+                time.sleep(0.1)
+        except requests.ConnectionError:
+            trials += 1
+
+    if result and len(result) > 0:
+        return FixedTarget(
+            Hours(_fix_simbad_coordinates(result[0]['RA'])),
+            Degrees(_fix_simbad_coordinates(result[0]['DEC'])),
+            _fix_simbad_name(result[0]['MAIN_ID']),
+            [_fix_simbad_name(ff) for ff in result[0]['IDS'].split('|')]
+        )
+    else:
+        print('No matches found or connection is down.')
+        return None