Metadata-Version: 2.1
Name: cosmotile
Version: 0.2.4
Summary: Cosmotile
Author-email: Steven Murray <steven.murray@sns.it>
License: MIT License
        
        Copyright © 2022 Steven Murray
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/steven-murray/cosmotile
Project-URL: documentation, https://cosmotile.readthedocs.io
Project-URL: changelog, https://github.com/steven-murray/cosmotile/releases
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Astronomy
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: <4.0,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: click>=8.0.1
Requires-Dist: numpy>=1.23.4
Requires-Dist: scipy>=1.9.3
Requires-Dist: astropy>=5.1.1
Requires-Dist: astropy-healpix>=0.7
Provides-Extra: perf
Requires-Dist: numba>=0.56.4; extra == "perf"
Provides-Extra: dev
Requires-Dist: sphinx>=4.3.2; extra == "dev"
Requires-Dist: sphinx-click>=3.0.2; extra == "dev"
Requires-Dist: sphinx-autobuild>=2021.3.14; extra == "dev"
Requires-Dist: myst-parser>=0.16.1; extra == "dev"
Requires-Dist: furo>=2021.11.12; extra == "dev"
Requires-Dist: pytest>=6.2.5; extra == "dev"
Requires-Dist: coverage[toml]>=6.2; extra == "dev"
Requires-Dist: pytest-cov>=3.0.0; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Provides-Extra: all
Requires-Dist: cosmotile[dev,perf]; extra == "all"

# Cosmotile

[![PyPI](https://img.shields.io/pypi/v/cosmotile.svg)][pypi_]
[![Status](https://img.shields.io/pypi/status/cosmotile.svg)][status]
[![Python Version](https://img.shields.io/pypi/pyversions/cosmotile)][python version]
[![License](https://img.shields.io/pypi/l/cosmotile)][license]

[![Read the documentation at https://cosmotile.readthedocs.io/](https://img.shields.io/readthedocs/cosmotile/latest.svg?label=Read%20the%20Docs)][read the docs]
[![Tests](https://github.com/steven-murray/cosmotile/workflows/Tests/badge.svg)][tests]
[![Codecov](https://codecov.io/gh/steven-murray/cosmotile/branch/main/graph/badge.svg)][codecov]

[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)][black]

[pypi_]: https://pypi.org/project/cosmotile/
[status]: https://pypi.org/project/cosmotile/
[python version]: https://pypi.org/project/cosmotile
[read the docs]: https://cosmotile.readthedocs.io/
[tests]: https://github.com/steven-murray/cosmotile/actions?workflow=Tests
[codecov]: https://app.codecov.io/gh/steven-murray/cosmotile
[pre-commit]: https://github.com/pre-commit/pre-commit
[black]: https://github.com/psf/black

_Create cosmological lightcones from coeval simulations._

This algorithm is taken from the code in https://github.com/piyanatk/cosmotile, but
is repackaged and re-tooled.

## Features

- Fast tiling of finite, periodic cosmic simulations onto arbitrary angular coordinates.
- Generate different realizations by translation and rotation.

## Installation

You can install _Cosmotile_ via [pip] from [PyPI]:

```console
$ pip install cosmotile
```

## Usage

Please see the [Command-line Reference] for details.

## Contributing

Contributions are very welcome.
To learn more, see the [Contributor Guide].

## License

Distributed under the terms of the [MIT license][license],
_Cosmotile_ is free and open source software.

## Issues

If you encounter any problems,
please [file an issue] along with a detailed description.

## Credits

This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter] template.

The algorithm used in this repository is derived from the `cosmotile` module in
https://github.com/nithyanandan/AstruUtils, which was later modularised in
https://github.com/piyanatk/cosmotile.

## Acknowledgments

If you find `cosmotile` useful in your project, please star this repository and, if
applicable, cite https://arxiv.org/abs/1708.00036.

[@cjolowicz]: https://github.com/cjolowicz
[pypi]: https://pypi.org/
[hypermodern python cookiecutter]: https://github.com/cjolowicz/cookiecutter-hypermodern-python
[file an issue]: https://github.com/steven-murray/cosmotile/issues
[pip]: https://pip.pypa.io/

<!-- github-only -->

[license]: https://github.com/steven-murray/cosmotile/blob/main/LICENSE
[contributor guide]: https://github.com/steven-murray/cosmotile/blob/main/CONTRIBUTING.md
[command-line reference]: https://cosmotile.readthedocs.io/en/latest/usage.html
