supspec


Namesupspec JSON
Version 1.0.7 PyPI version JSON
download
home_pagehttps://example.com
SummaryTools that update the pyOpenSci contributor and review metadata
upload_time2024-06-12 19:53:55
maintainerNone
docs_urlNone
authorJames
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # SupSpec

Hello! Thank you for using **SupSpec**!\
`SupSpec` (**Sup**ernova **Spec**tra Fitter) is a quick tool which aids in finding the velocity structure of spectral features throughout the supernova ejecta. This code is designed to require minimal user interaction and can ingest an arbitrarily large number of spectra. With it, one can infer both the velocity of supernova ejecta expansion, and the relative depths of various elements in the ejecta. The user can input spectral data in a range of formats (.txt, .data, .out, etc.), choose a spectral line and window, and receive an output of graphs. 


## Installation

`SupSpec` is available on `pip` and can be installed using:

```
pip install supspec
```

## Using SupSpec

Before using `SupSpec`, store all your data in a folder called "data". Then, open terminal at the location and run `run.py`. 

```
python run.py 
```

You can also pass in 3 arguments at the terminal: mode, directory, and extension.
- **Mode**: `-v` at the end of the command activates verbose mode. The default is quiet mode.
- **Directory**: `-d <directory>` at the end of the command sets that directory as the directory which holds spectroscopy data. The default directory is a folder called "data" inside the current directory.
- **Extension**: `-e <extension>` extends the type of file for spectroscopy data in addition to .txt, .data, or .out files.

In verbose mode, the user can check the window of each spectrum, change the number of walkers and iterations, and view the results of every walker. In quiet mode, figures will not pop up but simply stored inside the Result folder.

For example, if I wish to use verbose mode, and my data is stored in a folder called `spectra/`. I would type in the command:

```
python run.py -v -d spectra
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://example.com",
    "name": "supspec",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "James",
    "author_email": "james@example.com",
    "download_url": "https://files.pythonhosted.org/packages/69/e3/13cb38870a68758f5611e98d6f00ae3103fb702f8726f6d297b202a9882b/supspec-1.0.7.tar.gz",
    "platform": null,
    "description": "# SupSpec\n\nHello! Thank you for using **SupSpec**!\\\n`SupSpec` (**Sup**ernova **Spec**tra Fitter) is a quick tool which aids in finding the velocity structure of spectral features throughout the supernova ejecta. This code is designed to require minimal user interaction and can ingest an arbitrarily large number of spectra. With it, one can infer both the velocity of supernova ejecta expansion, and the relative depths of various elements in the ejecta. The user can input spectral data in a range of formats (.txt, .data, .out, etc.), choose a spectral line and window, and receive an output of graphs. \n\n\n## Installation\n\n`SupSpec` is available on `pip` and can be installed using:\n\n```\npip install supspec\n```\n\n## Using SupSpec\n\nBefore using `SupSpec`, store all your data in a folder called \"data\". Then, open terminal at the location and run `run.py`. \n\n```\npython run.py \n```\n\nYou can also pass in 3 arguments at the terminal: mode, directory, and extension.\n- **Mode**: `-v` at the end of the command activates verbose mode. The default is quiet mode.\n- **Directory**: `-d <directory>` at the end of the command sets that directory as the directory which holds spectroscopy data. The default directory is a folder called \"data\" inside the current directory.\n- **Extension**: `-e <extension>` extends the type of file for spectroscopy data in addition to .txt, .data, or .out files.\n\nIn verbose mode, the user can check the window of each spectrum, change the number of walkers and iterations, and view the results of every walker. In quiet mode, figures will not pop up but simply stored inside the Result folder.\n\nFor example, if I wish to use verbose mode, and my data is stored in a folder called `spectra/`. I would type in the command:\n\n```\npython run.py -v -d spectra\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Tools that update the pyOpenSci contributor and review metadata",
    "version": "1.0.7",
    "project_urls": {
        "Homepage": "https://example.com"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b7102f402c87f6613c60b95f45ee60931070004db38a542485daab70b808aff3",
                "md5": "d58b892707d13cb1f205b30c4c88248c",
                "sha256": "baedba812c1053c94e9d875e75ea4b3c6aceeb5d58789465f7528c8a98dc59cb"
            },
            "downloads": -1,
            "filename": "supspec-1.0.7-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "d58b892707d13cb1f205b30c4c88248c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 1953,
            "upload_time": "2024-06-12T19:53:54",
            "upload_time_iso_8601": "2024-06-12T19:53:54.316364Z",
            "url": "https://files.pythonhosted.org/packages/b7/10/2f402c87f6613c60b95f45ee60931070004db38a542485daab70b808aff3/supspec-1.0.7-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "69e313cb38870a68758f5611e98d6f00ae3103fb702f8726f6d297b202a9882b",
                "md5": "5b593ef58a4c7af3d31b8e1da4efe930",
                "sha256": "e1b33264c4e9f8f4fdf8e1d9657b1958d2893c59441703d7cc70884714fbfa47"
            },
            "downloads": -1,
            "filename": "supspec-1.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "5b593ef58a4c7af3d31b8e1da4efe930",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 2313,
            "upload_time": "2024-06-12T19:53:55",
            "upload_time_iso_8601": "2024-06-12T19:53:55.726618Z",
            "url": "https://files.pythonhosted.org/packages/69/e3/13cb38870a68758f5611e98d6f00ae3103fb702f8726f6d297b202a9882b/supspec-1.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-12 19:53:55",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "supspec"
}
        
Elapsed time: 1.14595s