{ "info": { "author": "Camellia Magness", "author_email": "cmagness@stsci.edu", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Science/Research", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Scientific/Engineering :: Astronomy", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "SpectrAOD\n------------\n![spectraod_technique](spectraod_ddrf_final.png)\n\n`spectrAOD` is a package for measuring the apparent optical depth, and thus,\n the apparent column density for spectral absorption features as outlined by\n Savage and Sembach in their 1991 paper. Many researchers have their own \n code for performing these measurements but we set out to create an \n open-source, well-maintained python package for people who didn't want to \n reinvent the wheel. Currently, the package has a limited use case scenario \n for Cosmic Origins Spectrograph data at a redshift of zero, but we hope to \n expand the capabilities of the package in terms of what missions are \n supported, the computation abilities, and visualization for these \n calculations. Stay tuned!\n\nInstallation\n------------\nThis package will soon be registered on PyPI and complete with its own \nenvironment file specifications, but until then you'll have to install it \nthe old fashioned way. You will need a working, and preferably current \nversion of Anaconda.\n\n##### Make a new environment\n```\nconda create --name python=3.5 \n```\nActivate the new environment with:\n```\nconda activate \n```\nWe recommend a short and simple name for the environment such as `spectraod`.\n\n##### Clone the repository and install it\nThis repository has a button near the top where you can click for the link \nto clone or download. Choose the https version unless you have set up an ssh\ntoken for Github. \nMove into the directory that you would like this package to live in, then:\n```\ngit clone https://github.com/cmagness/spectrAOD.git\ncd spectrAOD\npip install .\n```\nAlternately, if you are having issues installing with `pip`, you can also \nuse `python setup.py install`.\n\nUsing `spectrAOD`\n-----------------\n\n##### Configuring Settings\n\nIn this repository you will see a file called `sample_settings.yaml`. You \nwill need a settings file to use this package that is of the same format. \nCopy the settings file and rename it as you please. For `spectrAOD` to find \nthis file, you have two options:\n\n###### Set an environment variable (Recommended)\n\nWe recommend creating an environment variable in your `.bashrc` or `\n.bash_profile` to point to this file. To do so, open your `.bashrc` or `\n.bash_profile` in a text editor (this will be a hidden file in your home \ndirectory if you are unfamiliar) and then add the line:\n```\nexport SPECTRAOD_SETTINGS=\"/path/to/your/settings/file\"\n```\nSave and close your `.bash_profile` and then activate these changes with:\n```\nsource .bash_profile\n```\nNow `spectrAOD` will know where to look for your file. If you decide to move\nit, just update the path.\n\n###### Move your copy (Slightly faster)\n\nIf you don't want to mess with setting an environment variable, that is just\n fine. You can move your settings file to the directory you plan to run the \n package from and `spectrAOD` will look for a `.yaml` file if no environment\n variable is set. Just be warned that it will look for _any_ `.yaml` file.\n\n##### Running the package \n\nOnce you've told `spectrAOD` where to find your settings file, be sure to \nactually populate it. Each parameter in the sample file has a comment with \ninformation about what should go into that file. Remove that comment and \nreplace it with the default entries you want to use--don't worry, you can \nchange the value in each run from the command line.\n\n###### Setting a Target List\n\nIn the settings file you will notice one of the parameters asks for the path\n to your target list file. To perform the LSR correction `spectrAOD` needs a\n target list that has the RA and DEC. The target name needs to match the \n name that is used in the file header if you are processing fits files. You\n can see the format for this file (it must also be a csv at this time) in \n sample_targets.csv. Feel free to use that file to build your target list.\n\n###### Command line arguments\n\nTo run the default measurements you've put in that file, from the command \nline, in any directory, enter:\n```\nmeasure \n```\nor, from within the package level:\n```\npython measure_aod.py \n```\n\nWhere the ion is the name of the ion you wish to measure. Currently, you may\n use any of the ions in the `mini_ions.csv` list, or add your own in the \n same format to that file.\n\nTo see the full list of parameter options, run:\n```\nmeasure --help\n```\n\nThis will give you information about all the parameters you can change from \nthe command line. By default, `spectrAOD` will use the values in your \nsettings file but you can alter any of them from the default by adding the \ncorrect flag at the command line.\n\nSay you perform a measurement of NV in the region from -100 to 100 km/s but \nthen decide it may be advantageous to perform the measurement in the window \nfrom -100 to 150 km/s. You can do this without making changes to your \nsettings file by running:\n```\nmeasure NV --vel_max 150\n```\n\n \n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/cmagness/spectrAOD", "keywords": "astronomy", "license": "", "maintainer": "", "maintainer_email": "", "name": "spectrAOD", "package_url": "https://pypi.org/project/spectrAOD/", "platform": "", "project_url": "https://pypi.org/project/spectrAOD/", "project_urls": { "Homepage": "https://github.com/cmagness/spectrAOD" }, "release_url": "https://pypi.org/project/spectrAOD/0.0.1/", "requires_dist": [ "setuptools", "numpy", "astropy", "pandas", "argparse" ], "requires_python": ">=3.5", "summary": "This package is for measuring the apparent optical depth of spectra", "version": "0.0.1" }, "last_serial": 5923664, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "491ff37eb65853f36f2b2724c1c5a698", "sha256": "a522e1772d02179be33e55ef0f1ebf5e1bdb922abf92a066f96bd980654290a0" }, "downloads": -1, "filename": "spectrAOD-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "491ff37eb65853f36f2b2724c1c5a698", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 14898, "upload_time": "2019-10-03T14:05:22", "url": "https://files.pythonhosted.org/packages/b0/3e/e49eba96caae9b047571af840f78f8b543663c94953dd0582f58eca636f5/spectrAOD-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1ebb4a04efd47c0e4662a5bfc9915b03", "sha256": "1892fe6db35442cff98bf0846876f2b37e36601799f52b23784fb9fc9921230a" }, "downloads": -1, "filename": "spectrAOD-0.0.1.tar.gz", "has_sig": false, "md5_digest": "1ebb4a04efd47c0e4662a5bfc9915b03", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 12510, "upload_time": "2019-10-03T14:05:25", "url": "https://files.pythonhosted.org/packages/5a/41/49b61564c377a2c2ee78e38148e1624efa7358334e879ed2490c0b076053/spectrAOD-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "491ff37eb65853f36f2b2724c1c5a698", "sha256": "a522e1772d02179be33e55ef0f1ebf5e1bdb922abf92a066f96bd980654290a0" }, "downloads": -1, "filename": "spectrAOD-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "491ff37eb65853f36f2b2724c1c5a698", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 14898, "upload_time": "2019-10-03T14:05:22", "url": "https://files.pythonhosted.org/packages/b0/3e/e49eba96caae9b047571af840f78f8b543663c94953dd0582f58eca636f5/spectrAOD-0.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1ebb4a04efd47c0e4662a5bfc9915b03", "sha256": "1892fe6db35442cff98bf0846876f2b37e36601799f52b23784fb9fc9921230a" }, "downloads": -1, "filename": "spectrAOD-0.0.1.tar.gz", "has_sig": false, "md5_digest": "1ebb4a04efd47c0e4662a5bfc9915b03", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 12510, "upload_time": "2019-10-03T14:05:25", "url": "https://files.pythonhosted.org/packages/5a/41/49b61564c377a2c2ee78e38148e1624efa7358334e879ed2490c0b076053/spectrAOD-0.0.1.tar.gz" } ] }