fact4astro


Namefact4astro JSON
Version 2024.8.26 PyPI version JSON
download
home_pageNone
SummaryA python package for astrometric catalog analyses
upload_time2024-08-27 07:53:40
maintainerNone
docs_urlNone
authorNone
requires_python>=3.0
licenseNone
keywords astrometry catalog vlbi gaia
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Fundamental Astrometric Catalog Tools (FACT)

A Python package for processing fundamental astrometric catalogs used in our group.

[![PyPI version](https://badge.fury.io/py/fact.svg)](https://badge.fury.io/py/fact)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Features

- Parse and process fundamental astrometric catalogs like ICRF3.

## Modules

- **cat_parser**: Read commonly used astrometric catalogs, for example, ICRF3 catalogs.

## Installation

You can install FACT using pip from PyPI:

```bash
pip install fact
```

## Requirements

When you install FACT via pip, the necessary dependencies will be automatically installed. These include any libraries required for the core functionalities of the package.

## Usage

Here's an example of how to use the cat_parser module to read an ICRF3 catalog:
```
from fact.cat_parser import read_icrf3

icrf3_data = read_icrf3("path_to_icrf3_catalog")
print(icrf3_data)
```

More detailed examples and usage guidelines will be available in the manual, which is currently under development.

## Documentation

The manual is under development and will be available soon. We encourage users to provide feedback and suggestions to help improve the package and its documentation.

## Contributing

Contributions are welcome! If you'd like to contribute to FACT, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bugfix (`git checkout -b feature-name`).
3. Make your changes and commit them with a clear message (`git commit -m "Add new feature"`).
4. Push to the branch (`git push origin feature-name`).
5. Submit a pull request.

For major changes, please open an issue first to discuss what you would like to change.

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/username/FACT/blob/main/LICENSE) file for details.

## Acknowledgements

This package was developed by our research group, and we would like to thank the [Paris Observatory Geodetic VLBI Center](https://ivsopar.obspm.fr/) for providing the VLBI products that form a crucial part of this work.

## Contact

For questions, suggestions, or support, please contact [Niu](niu.liu@nju.edu.cn).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "fact4astro",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.0",
    "maintainer_email": "Niu Liu <niu.liu@nju.edu.cn>",
    "keywords": "astrometry, catalog, vlbi, gaia",
    "author": null,
    "author_email": "Niu Liu <niu.liu@nju.edu.cn>",
    "download_url": "https://files.pythonhosted.org/packages/c0/71/dd596069e046f7b24447a9fbcc83e430d664c1ca995204fb4d888529d6f9/fact4astro-2024.8.26.tar.gz",
    "platform": null,
    "description": "# Fundamental Astrometric Catalog Tools (FACT)\n\nA Python package for processing fundamental astrometric catalogs used in our group.\n\n[![PyPI version](https://badge.fury.io/py/fact.svg)](https://badge.fury.io/py/fact)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n## Features\n\n- Parse and process fundamental astrometric catalogs like ICRF3.\n\n## Modules\n\n- **cat_parser**: Read commonly used astrometric catalogs, for example, ICRF3 catalogs.\n\n## Installation\n\nYou can install FACT using pip from PyPI:\n\n```bash\npip install fact\n```\n\n## Requirements\n\nWhen you install FACT via pip, the necessary dependencies will be automatically installed. These include any libraries required for the core functionalities of the package.\n\n## Usage\n\nHere's an example of how to use the cat_parser module to read an ICRF3 catalog:\n```\nfrom fact.cat_parser import read_icrf3\n\nicrf3_data = read_icrf3(\"path_to_icrf3_catalog\")\nprint(icrf3_data)\n```\n\nMore detailed examples and usage guidelines will be available in the manual, which is currently under development.\n\n## Documentation\n\nThe manual is under development and will be available soon. We encourage users to provide feedback and suggestions to help improve the package and its documentation.\n\n## Contributing\n\nContributions are welcome! If you'd like to contribute to FACT, please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch for your feature or bugfix (`git checkout -b feature-name`).\n3. Make your changes and commit them with a clear message (`git commit -m \"Add new feature\"`).\n4. Push to the branch (`git push origin feature-name`).\n5. Submit a pull request.\n\nFor major changes, please open an issue first to discuss what you would like to change.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](https://github.com/username/FACT/blob/main/LICENSE) file for details.\n\n## Acknowledgements\n\nThis package was developed by our research group, and we would like to thank the [Paris Observatory Geodetic VLBI Center](https://ivsopar.obspm.fr/) for providing the VLBI products that form a crucial part of this work.\n\n## Contact\n\nFor questions, suggestions, or support, please contact [Niu](niu.liu@nju.edu.cn).\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A python package for astrometric catalog analyses",
    "version": "2024.8.26",
    "project_urls": {
        "Changelog": "https://git.nju.edu.cn/neo/fact/-/blob/main/CHANGELOG",
        "Homepage": "https://pypi.org/project/fact4astro/",
        "Repository": "https://git.nju.edu.cn/neo/fact.git"
    },
    "split_keywords": [
        "astrometry",
        " catalog",
        " vlbi",
        " gaia"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "99acdbdb3ae7d28df1d17384d67ac70585de5a8eae974a52797399a8af625fee",
                "md5": "b835f1636f9bb9d33ab688586c8b60ed",
                "sha256": "6f2c48b0651f83690a7d76680b5415ec1d9ec95f4684ce14a5c654aae1a8c551"
            },
            "downloads": -1,
            "filename": "fact4astro-2024.8.26-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b835f1636f9bb9d33ab688586c8b60ed",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.0",
            "size": 48201,
            "upload_time": "2024-08-27T07:53:35",
            "upload_time_iso_8601": "2024-08-27T07:53:35.707707Z",
            "url": "https://files.pythonhosted.org/packages/99/ac/dbdb3ae7d28df1d17384d67ac70585de5a8eae974a52797399a8af625fee/fact4astro-2024.8.26-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c071dd596069e046f7b24447a9fbcc83e430d664c1ca995204fb4d888529d6f9",
                "md5": "2048937f0223d7b3d0a3c7bac1a96461",
                "sha256": "786e5f478df0139437352ca98fb45e1f497c182c03076d7888bfa9eb4e87ac26"
            },
            "downloads": -1,
            "filename": "fact4astro-2024.8.26.tar.gz",
            "has_sig": false,
            "md5_digest": "2048937f0223d7b3d0a3c7bac1a96461",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.0",
            "size": 5951964,
            "upload_time": "2024-08-27T07:53:40",
            "upload_time_iso_8601": "2024-08-27T07:53:40.199420Z",
            "url": "https://files.pythonhosted.org/packages/c0/71/dd596069e046f7b24447a9fbcc83e430d664c1ca995204fb4d888529d6f9/fact4astro-2024.8.26.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-27 07:53:40",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "fact4astro"
}
        
Elapsed time: 1.89365s