From ff28969e989b5e259fd9a08eb1d06ded2384b34f Mon Sep 17 00:00:00 2001 From: Sebastian Achim Mueller Date: Tue, 14 Nov 2023 10:17:54 +0100 Subject: [PATCH] adopting black-pack --- README.md | 17 ----------------- README.rst | 46 ++++++++++++++++++++++++++++++++++++++++++++++ setup.py | 2 +- 3 files changed, 47 insertions(+), 18 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index cfa27b9..0000000 --- a/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# Cable-Robo-Mount - -[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) - -A mount for the Cherenkov-plenoscope that can be build today. - -### Working together -The [ETH Institute for Particle Physics](http://www.ipp.phys.ethz.ch/) explores together with the [ETH Department for Civil Engineering](https://www.baug.ethz.ch/en/) the possibilites to build nothing less but the most powerfull cosmic gamma-ray-timing-explorer ever planned. - -From the first drafts -![img](readme/sebastians_acp_draft_33deg_zd.jpg) - -to the first concepts for an implementation... -![img](readme/first_implementation.jpg) - -### Simulating the mount -Finite element simulations from civil engineering are combined with [scinetific raytracing](https://github.com/cherenkov-plenoscope/merlict_development_kit) from particle physics. Together, the mechanical structure of the novel cable-robo-mount is investigated using its optical performance as a feedback. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..16a81bb --- /dev/null +++ b/README.rst @@ -0,0 +1,46 @@ +################ +Cable-Robo-Mount +################ +|TestStatus| |PyPiStatus| |BlackStyle| |BlackPackStyle| |MITLicenseBadge| + +A mount for the Cherenkov-plenoscope that can be build today. + +**************** +Working together +**************** +The [ETH Institute for Particle Physics](http://www.ipp.phys.ethz.ch/) explores together with the [ETH Department for Civil Engineering](https://www.baug.ethz.ch/en/) the possibilites to build nothing less but the most powerfull cosmic gamma-ray-timing-explorer ever planned. + + +From the first drafts + +|ImgFirstDraft| + +to the first concepts for an implementation... + +|ImgSophisticatedDraft| + + +******************** +Simulating the mount +******************** +Finite element simulations from civil engineering are combined with [scinetific raytracing](https://github.com/cherenkov-plenoscope/merlict_development_kit) from particle physics. Together, the mechanical structure of the novel cable-robo-mount is investigated using its optical performance as a feedback. + + +.. |BlackStyle| image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + +.. |TestStatus| image:: https://github.com/cherenkov-plenoscope/cable_robo_mount/actions/workflows/test.yml/badge.svg?branch=main + :target: https://github.com/cherenkov-plenoscope/cable_robo_mount/actions/workflows/test.yml + +.. |PyPiStatus| image:: https://img.shields.io/pypi/v/cable_robo_mount + :target: https://pypi.org/project/cable_robo_mount + +.. |BlackPackStyle| image:: https://img.shields.io/badge/pack%20style-black-000000.svg + :target: https://github.com/cherenkov-plenoscope/black_pack + +.. |MITLicenseBadge| image:: https://img.shields.io/badge/License-MIT-yellow.svg + :target: https://opensource.org/licenses/MIT + +.. |ImgFirstDraft| image:: https://github.com/cherenkov-plenoscope/cable_robo_mount/blob/main/readme/sebastians_acp_draft_33deg_zd.jpg?raw=True + +.. |ImgSophisticatedDraft| image:: https://github.com/cherenkov-plenoscope/cable_robo_mount/blob/main/readme/first_implementation.jpg?raw=True diff --git a/setup.py b/setup.py index 6168478..2bb8de5 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ version=version, description="Simulating a segmented imaging reflector", long_description=long_description, - long_description_content_type="text/markdown", + long_description_content_type="text/x-rst", author="Spyridon Daglas, Sebastian Achim Mueller", author_email="spirosdag@gmail.com", url="https://github.com/cherenkov-plenoscope/cable_robo_mount",