arvi 0.1.16__py3-none-any.whl → 0.1.19__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

@@ -1,4 +1,5 @@
 import os
+import sys
 import time
 from contextlib import contextmanager
 try:
@@ -21,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):
@@ -67,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
@@ -82,6 +87,44 @@ 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
+    ┌──────┬─────────────┬────┬───────┐
+    │ True │ short       │ 77 │ catty │
+    ├──────┼─────────────┼────┼───────┤
+    │ 36   │ long phrase │ 9  │ dog   │
+    ├──────┼─────────────┼────┼───────┤
+    │ 8    │ medium      │ 3  │ zebra │
+    └──────┴─────────────┴────┴───────┘
+    """
+    _print = logger.info if logger else print
+
+    # find the max length of each column
+    max_col_lens = list(map(max, zip(*[(len(str(cell)) for cell in row) for row in rows])))
+
+    # print the table's top border
+    _print('┌' + '┬'.join('─' * (n + 2) for n in max_col_lens) + '┐')
+
+    rows_separator = '├' + '┼'.join('─' * (n + 2) for n in max_col_lens) + '┤'
+
+    row_fstring = ' │ '.join("{: <%s}" % n for n in max_col_lens)
+
+    for i, row in enumerate(rows):
+        _print('│ ' + row_fstring.format(*map(str, row)) + ' │')
+        
+        if line_between_rows and i < len(rows) - 1:
+            _print(rows_separator)
+
+    # print the table's bottom border
+    _print('└' + '┴'.join('─' * (n + 2) for n in max_col_lens) + '┘')
+
+
 def strtobool(val):
     """Convert a string representation of truth to true (1) or false (0).
 
@@ -106,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)
@@ -163,4 +211,12 @@ def get_max_berv_span(self, n=None):
         inds.append(b2)
     return np.array(inds[:n])
 
+def get_object_fast(file):
+    with open(file, 'rb') as f:
+        f.read(800) # read first 10 keywords
+        key = f.read(8)
+        assert key == b'OBJECT  ', 'Object keyword not found.'
+        f.read(2)
+        value = f.read(20)
+    return value.decode().split("'")[1].strip()
 

{arvi-0.1.16.dist-info → arvi-0.1.19.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arvi
-Version: 0.1.16
+Version: 0.1.19
 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.19.dist-info/RECORD

@@ -0,0 +1,36 @@
+arvi/HZ.py,sha256=u7rguhlILRBW-LOczlY3dkIB4LM8p8W7Xfg4FnNaYG0,2850
+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=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=icm3LJjG9pjP47_bM30NFyocUQO3X3SHS5yQ-Dwcr5w,4653
+arvi/headers.py,sha256=uvdJebw1M5YkGjE3vJJwYBOnLikib75uuZE9FXB5JJM,1673
+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=ayPdZ4HZO9iCDdnADQ18gQPJh79o-1UYG7TYkvm9Lrc,4051
+arvi/setup_logger.py,sha256=pBzaRTn0hntozjbaRVx0JIbWGuENkvYUApa6uB-FsRo,279
+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=tiMky3YESl3Hul02RTB6lQmAMfvByJ3bkNCLncpyips,71278
+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.19.dist-info/LICENSE,sha256=6JfQgl7SpM55t0EHMFNMnNh-AdkpGW25MwMiTnhdWQg,1068
+arvi-0.1.19.dist-info/METADATA,sha256=1-fwifbRRjnymfS-6JSA9KF07VYE-ZisksHT7l3Bp-Q,1852
+arvi-0.1.19.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+arvi-0.1.19.dist-info/top_level.txt,sha256=4EeiKDVLD45ztuflTGfQ3TU8GVjJg5Y95xS5XjI-utU,5
+arvi-0.1.19.dist-info/RECORD,,

{arvi-0.1.16.dist-info → arvi-0.1.19.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
 

arvi-0.1.16.dist-info/RECORD

@@ -1,35 +0,0 @@
-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/binning.py,sha256=jbemJ-bM3aqoOsqMo_OhWt_co-JAQ0nhdG_GpTsrRsw,15403
-arvi/config.py,sha256=wyj6FTxN7QOZj8LaHAe_ZdPKVfrNfobNNOHRNLH-S7Q,339
-arvi/dace_wrapper.py,sha256=F0MIfAFmZJ-wBGNAkhxLqrcFUyfqdFIT4aCD_5LxILs,16912
-arvi/extra_data.py,sha256=WEEaYeLh52Zdv0uyHO72Ys5MWS3naTAP4wJV2BJ1mbk,2551
-arvi/gaia_wrapper.py,sha256=sapurDBceHbj-pj9t9hcPUrg-3NZEoQouo__lXFD6p8,3554
-arvi/headers.py,sha256=uvdJebw1M5YkGjE3vJJwYBOnLikib75uuZE9FXB5JJM,1673
-arvi/instrument_specific.py,sha256=fhkvR5jJzpJH7XbT8Fbzkaz6tGeoFYugkJCIAJgSR7o,4746
-arvi/lbl_wrapper.py,sha256=_ViGVkpakvuBR_xhu9XJRV5EKHpj5Go6jBZGJZMIS2Y,11850
-arvi/nasaexo_wrapper.py,sha256=mWt7eHgSZe4MBKCmUvMPTyUPGuiwGTqKugNBvmjOg9s,7306
-arvi/plots.py,sha256=92z0A46cnVdGv840oZZ7PP_fssZECYe5Zyl5OZl1p3k,27996
-arvi/programs.py,sha256=C0Fbldjf-QEZYYJp5wBKP3h7zraD0O2mJC7Su967STg,4607
-arvi/reports.py,sha256=8HiwWdaOh_P2V4-F6PV4TjasZLeZ8kC5dUYB1tQam1o,3368
-arvi/setup_logger.py,sha256=pBzaRTn0hntozjbaRVx0JIbWGuENkvYUApa6uB-FsRo,279
-arvi/simbad_wrapper.py,sha256=d8svoEUF6in2M3WrqSXfJ_drwnXD1NGPUnxP94qUOI0,5579
-arvi/spectra.py,sha256=pTAWSW4vk96DWRQ-6l5mNJHUhiAyaPR-QDjZdOT6Ak0,7489
-arvi/stats.py,sha256=ilzzGL9ew-SyVa9eEdrYCpD3DliOAwhoNUg9LIlHjzU,2583
-arvi/stellar.py,sha256=MdO1_-ZXHnMHbkG-a5LvrnYeULy6MCAnWMKPvR4NZxQ,2954
-arvi/timeseries.py,sha256=sdm9l_LHItZHDAVI6r_wsQwkrfbuMX46q3Wqs0y-KGA,60787
-arvi/translations.py,sha256=SUIrJHt3JZdL_GQh3OJyg2Gm3X5ut86w5zW8hZpxHe0,498
-arvi/utils.py,sha256=2TEj6t_6gW6dPQTPn5AFyg_F5SdI7P6IUGkecOkzoV4,4387
-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.16.dist-info/LICENSE,sha256=6JfQgl7SpM55t0EHMFNMnNh-AdkpGW25MwMiTnhdWQg,1068
-arvi-0.1.16.dist-info/METADATA,sha256=5xv7DMFQMyaJqAMJji4_56s4aDZnumycmVsECnUImS4,1250
-arvi-0.1.16.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
-arvi-0.1.16.dist-info/top_level.txt,sha256=4EeiKDVLD45ztuflTGfQ3TU8GVjJg5Y95xS5XjI-utU,5
-arvi-0.1.16.dist-info/RECORD,,