Skip to content

Commit

Permalink
MAINT: Update README and LICENSE (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
ntessore authored Jan 24, 2023
1 parent ae0b5b5 commit ee560b5
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 39 deletions.
16 changes: 11 additions & 5 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
No License
MIT License

Copyright (c) 2022 Nicolas Tessore
Copyright (c) 2022 The GLASS Developers

The code is currently in "early access" and does not come with a license for
distribution by third parties. However, it can be freely installed and used.
After early access, the code will be licensed under the MIT license.
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,
Expand Down
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

**GLASS**: Generator for Large Scale Structure
==============================================

[![Gitter](https://badges.gitter.im/glass-dev/glass.svg)](https://gitter.im/glass-dev/glass)
[![Documentation](https://readthedocs.org/projects/glass/badge/?version=latest)](https://glass.readthedocs.io/en/latest/)

This is the core library for GLASS, the Generator for Large Scale Structure.
For more information, see the full [documentation]. There are a number of
[examples] to get you started.


Installation
------------

Releases of the code can be installed with pip as usual:

pip install glass

If you are interested in the latest version of the code, you can pip-install
this repository:

pip install git+https://github.com/glass-dev/glass.git


Citation
--------

If you use GLASS simulations or the GLASS library in your research, please cite
the original paper.


[documentation]: https://glass.readthedocs.io/
[examples]: https://glass.readthedocs.io/projects/examples/
[glass-camb]: https://github.com/glass-dev/glass-camb/
33 changes: 0 additions & 33 deletions README.rst

This file was deleted.

2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = 2023.1
maintainer = Nicolas Tessore
maintainer_email = [email protected]
description = Generator for Large Scale Structure
long_description = file: README.rst
long_description = file: README.md
long_description_content_type = text/x-rst
license = MIT
license_file = LICENSE
Expand Down

0 comments on commit ee560b5

Please sign in to comment.