arvi 0.1.18__py3-none-any.whl → 0.1.20__py3-none-any.whl

arvi/translations.py

@@ -5,19 +5,27 @@ STARS = {
     'Barnard': 'GJ699',
     "Barnard's": 'GJ699',
     'Ross128': 'Ross  128',
+    'Ross 128': 'Ross  128',
 }
 
 
-def translate(star):
+def translate(star, ngc=False, ic=False):
     # known translations
     if star in STARS:
         return STARS[star]
 
     # regex translations
-    NGC_match = re.match(r'NGC([\s\d]+)No([\s\d]+)', star)
-    if NGC_match:
-        cluster = NGC_match.group(1).replace(' ', '')
-        target = NGC_match.group(2).replace(' ', '')
-        return f'Cl* NGC {cluster} MMU {target}'
+    if ngc:
+        NGC_match = re.match(r'NGC([\s\d]+)No([\s\d]+)', star)
+        if NGC_match:
+            cluster = NGC_match.group(1).replace(' ', '')
+            target = NGC_match.group(2).replace(' ', '')
+            return f'Cl* NGC {cluster} MMU {target}'
+    if ic:
+        IC_match = re.match(r'IC([\s\d]+)No([\s\d]+)', star)
+        if IC_match:
+            cluster = IC_match.group(1).replace(' ', '')
+            target = IC_match.group(2).replace(' ', '')
+            return f'Cl* IC {cluster} MMU {target}'
 
     return star

arvi/utils.py

@@ -22,7 +22,7 @@ except ImportError:
     trange = lambda *args, **kwargs: range(*args, **kwargs)
 
 from .setup_logger import logger
-from . import config
+from .config import config
 
 
 def create_directory(directory):
@@ -68,13 +68,17 @@ def all_logging_disabled():
 
 
 @contextmanager
-def timer():
+def timer(name=None):
     """ A simple context manager to time a block of code """
     if not config.debug:
         yield
         return
 
-    logger.debug(f'starting timer')
+    if name is None:
+        logger.debug('starting timer')
+    else:
+        logger.debug(f'starting timer: {name}')
+
     start = time.time()
     try:
         yield
@@ -83,6 +87,11 @@ def timer():
         logger.debug(f'elapsed time: {end - start:.2f} seconds')
 
 
+def sanitize_path(path):
+    if os.name == 'nt':  # on Windows, be careful with ':' in filename
+        path = path.replace(':', '_')
+    return path
+
 def pretty_print_table(rows, line_between_rows=True, logger=None):
     """
     Example Output
@@ -140,6 +149,11 @@ def there_is_internet(timeout=1):
         pass
     return False
 
+def get_data_path():
+    here = os.path.dirname(os.path.abspath(__file__))
+    data_path = os.path.join(here, 'data')
+    return data_path
+
 def find_data_file(file):
     here = os.path.dirname(os.path.abspath(__file__))
     data_file = os.path.join(here, '..', 'data', file)

{arvi-0.1.18.dist-info → arvi-0.1.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arvi
-Version: 0.1.18
+Version: 0.1.20
 Summary: The Automated RV Inspector
 Author-email: João Faria <joao.faria@unige.ch>
 License: MIT
@@ -25,8 +25,41 @@ Requires-Dist: mock; python_version < "3.3"
   <img width = "140" src="https://github.com/j-faria/arvi/blob/main/docs/logo/logo.png?raw=true"/>
 </p>
 
+This package sits alongside [DACE](https://dace.unige.ch/) to help with the
+analysis of radial velocity datasets.  
+It has been used within the ESPRESSO GTO program, and may be useful for other
+surveys and instruments.
 
 
+## Getting started
+
+Install `arvi` using pip  
+
+```sh
+pip install arvi
+
+# or
+pip install arvi -U # to update
+```
+
+
+Then either directly import a given target
+
+```py
+from arvi import HD1234
+```
+
+or create an instance of the `RV` class
+
+```py
+from arvi import RV
+s = RV('HD1234', instrument='ESPRESSO')
+```
+
+#### Current version
+
+![PyPI - Version](https://img.shields.io/pypi/v/arvi)
+
 #### Actions
 
 [![Deploy docs](https://github.com/j-faria/arvi/actions/workflows/docs-gh-pages.yml/badge.svg)](https://github.com/j-faria/arvi/actions/workflows/docs-gh-pages.yml)

{arvi-0.1.18.dist-info → arvi-0.1.20.dist-info}/RECORD

@@ -1,35 +1,36 @@
 arvi/HZ.py,sha256=u7rguhlILRBW-LOczlY3dkIB4LM8p8W7Xfg4FnNaYG0,2850
-arvi/__init__.py,sha256=stLL3UtXmR1jpNEoMyVohjvkCatunz1w5ZK0ApmWuYQ,814
-arvi/ariadne_wrapper.py,sha256=jv8Wl35LfHl1UH1EklbvxHcQHqaEDhRGNogSYjFt7Y4,2141
-arvi/berv.py,sha256=5avwcmc2nkYH1KDo-z4eMPsS1ElNvold2DWkziV13gE,17633
+arvi/__init__.py,sha256=r3oaMVwQCjNTd6odg-ga9IRncn54i7tawZrIrvSRQOo,1012
+arvi/ariadne_wrapper.py,sha256=YvilopJa9T4NwPcj3Nah_U8smSeSAU5-HYZMb_GJ-BQ,2232
+arvi/berv.py,sha256=eKnpuPC1w45UrUEyFRbs9F9j3bXz3kxYzNXbnRgvFQM,17596
 arvi/binning.py,sha256=jbemJ-bM3aqoOsqMo_OhWt_co-JAQ0nhdG_GpTsrRsw,15403
-arvi/config.py,sha256=wyj6FTxN7QOZj8LaHAe_ZdPKVfrNfobNNOHRNLH-S7Q,339
-arvi/dace_wrapper.py,sha256=YZ7V_l--weBnsguGEBq3tLTbHbCdKlJUrWmtV6hk8XU,18165
+arvi/config.py,sha256=ftqR38bV-zohTynPguiKSp4kSHPjiqJwEi-u6dFrFwk,1047
+arvi/dace_wrapper.py,sha256=ml0xC_KR-oXwEo6ysODzfpx-eP7VNbxURZSns31WbK4,18196
 arvi/extra_data.py,sha256=WEEaYeLh52Zdv0uyHO72Ys5MWS3naTAP4wJV2BJ1mbk,2551
-arvi/gaia_wrapper.py,sha256=R3wHoMuuuQFp9Wa6Ee8dxjffd21xZsns7vNmUrjVogE,4494
+arvi/gaia_wrapper.py,sha256=icm3LJjG9pjP47_bM30NFyocUQO3X3SHS5yQ-Dwcr5w,4653
 arvi/headers.py,sha256=uvdJebw1M5YkGjE3vJJwYBOnLikib75uuZE9FXB5JJM,1673
-arvi/instrument_specific.py,sha256=BCRhM74nCIiPfETEZW94zPHTymKnOExPcQ5wPjiblYU,7774
+arvi/instrument_specific.py,sha256=-pbm2Vk3iK_1K7nDa1avlJOKHBcXllwILI4lQn-Ze-A,7761
+arvi/kima_wrapper.py,sha256=y_Z0Hl2ECbs2-B6ZR9retrjId7-QxcRylG7b5aDsiFk,2306
 arvi/lbl_wrapper.py,sha256=_ViGVkpakvuBR_xhu9XJRV5EKHpj5Go6jBZGJZMIS2Y,11850
 arvi/nasaexo_wrapper.py,sha256=mWt7eHgSZe4MBKCmUvMPTyUPGuiwGTqKugNBvmjOg9s,7306
 arvi/plots.py,sha256=WUm-sqN0aZTNXvE1kYpvmHTW9QPWqSCpKhNjwaqxjEk,29628
 arvi/programs.py,sha256=C0Fbldjf-QEZYYJp5wBKP3h7zraD0O2mJC7Su967STg,4607
-arvi/reports.py,sha256=8HiwWdaOh_P2V4-F6PV4TjasZLeZ8kC5dUYB1tQam1o,3368
+arvi/reports.py,sha256=ayPdZ4HZO9iCDdnADQ18gQPJh79o-1UYG7TYkvm9Lrc,4051
 arvi/setup_logger.py,sha256=pBzaRTn0hntozjbaRVx0JIbWGuENkvYUApa6uB-FsRo,279
-arvi/simbad_wrapper.py,sha256=d-LX_zBEwcBGo4b5SkzRDb6TanV6n-Tg1OHTcoeRAjA,5709
+arvi/simbad_wrapper.py,sha256=f6QYrMN0KzBH9KhdrUR5w6ZK00EoRIYr3Z9jS4CzP_s,5791
 arvi/spectra.py,sha256=pTAWSW4vk96DWRQ-6l5mNJHUhiAyaPR-QDjZdOT6Ak0,7489
 arvi/stats.py,sha256=ilzzGL9ew-SyVa9eEdrYCpD3DliOAwhoNUg9LIlHjzU,2583
 arvi/stellar.py,sha256=veuL_y9kJvvApU_jqYQqP3EkcRnQffTc8Us6iT5UrFI,3790
-arvi/timeseries.py,sha256=sdm9l_LHItZHDAVI6r_wsQwkrfbuMX46q3Wqs0y-KGA,60787
-arvi/translations.py,sha256=SUIrJHt3JZdL_GQh3OJyg2Gm3X5ut86w5zW8hZpxHe0,498
-arvi/utils.py,sha256=DP8ryH7RZCWmV99fUJ2zImyiWn-mHbkbd-hhCHYRsFc,6145
+arvi/timeseries.py,sha256=OVxzJSopPNmE47HRn7hQO_2SQdEpVU1OvR1VV8C1DM0,71307
+arvi/translations.py,sha256=FBF_2OrpMQBG4GtV4_UOspiaxetiGCY7TQFcwZMMVuQ,838
+arvi/utils.py,sha256=ihQcYvk_ix52CW8fVP16CKTVEamGU5gPNRneVcgDrWc,6534
 arvi/data/info.svg,sha256=0IMI6W-eFoTD8acnury79WJJakpBwLa4qKS4JWpsXiI,489
 arvi/data/obs_affected_ADC_issues.dat,sha256=tn93uOL0eCTYhireqp1wG-_c3CbxPA7C-Rf-pejVY8M,10853
 arvi/data/obs_affected_blue_cryostat_issues.dat,sha256=z4AK17xfz8tGTDv1FjRvQFnio4XA6PNNfDXuicewHk4,1771
 arvi/data/extra/HD86226_PFS1.rdb,sha256=vfAozbrKHM_j8dYkCBJsuHyD01KEM1asghe2KInwVao,3475
 arvi/data/extra/HD86226_PFS2.rdb,sha256=F2P7dB6gVyzCglUjNheB0hIHVClC5RmARrGwbrY1cfo,4114
 arvi/data/extra/metadata.json,sha256=C69hIw6CohyES6BI9vDWjxwSz7N4VOYX0PCgjXtYFmU,178
-arvi-0.1.18.dist-info/LICENSE,sha256=6JfQgl7SpM55t0EHMFNMnNh-AdkpGW25MwMiTnhdWQg,1068
-arvi-0.1.18.dist-info/METADATA,sha256=KMcNbj2gpWbTJgfLTi6QcnrVhUU3v_ir7v_vx1Q1XFs,1250
-arvi-0.1.18.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-arvi-0.1.18.dist-info/top_level.txt,sha256=4EeiKDVLD45ztuflTGfQ3TU8GVjJg5Y95xS5XjI-utU,5
-arvi-0.1.18.dist-info/RECORD,,
+arvi-0.1.20.dist-info/LICENSE,sha256=6JfQgl7SpM55t0EHMFNMnNh-AdkpGW25MwMiTnhdWQg,1068
+arvi-0.1.20.dist-info/METADATA,sha256=wScAhfEK59QQD1OdPPhv-NHAdYjQznKOPebHA5XVmRQ,1852
+arvi-0.1.20.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+arvi-0.1.20.dist-info/top_level.txt,sha256=4EeiKDVLD45ztuflTGfQ3TU8GVjJg5Y95xS5XjI-utU,5
+arvi-0.1.20.dist-info/RECORD,,

{arvi-0.1.18.dist-info → arvi-0.1.20.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.1.0)
+Generator: setuptools (75.3.0)
 Root-Is-Purelib: true
 Tag: py3-none-any