https://github.com/georgysk/alcor

Kinematical studies of white dwarfs populations
https://github.com/georgysk/alcor

astrophysics white-dwarfs

Last synced: about 1 month ago
JSON representation

Kinematical studies of white dwarfs populations

• Host: GitHub
• URL: https://github.com/georgysk/alcor
• Owner: GeorgySk
• License: mit
• Created: 2017-04-29T09:39:14.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-01-14T17:30:13.000Z (almost 5 years ago)
• Last Synced: 2024-11-05T08:18:26.090Z (about 2 months ago)
• Topics: astrophysics, white-dwarfs
• Language: Fortran
• Homepage:
• Size: 9.04 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=====

alcor

=====

.. image:: https://travis-ci.org/wolvespack/alcor.svg?branch=master

  :target:  https://travis-ci.org/wolvespack/alcor

.. image:: https://codecov.io/gh/wolvespack/alcor/branch/master/graph/badge.svg

  :target: https://codecov.io/gh/wolvespack/alcor

.. image:: https://badge.fury.io/py/alcor.svg

  :target: https://badge.fury.io/py/alcor

In what follows ``python3`` is an alias for ``python3.5``

or any later version (``python3.6`` and so on).

Installation

------------

Install the latest ``pip`` & ``setuptools`` packages versions

.. code-block:: bash

  python3 -m pip install --upgrade pip setuptools

Release

~~~~~~~

Download and install the latest stable version from ``PyPI`` repository

.. code-block:: bash

  python3 -m pip install --upgrade alcor

Developer

~~~~~~~~~

Download and install the latest version from ``GitHub`` repository

.. code-block:: bash

  git clone https://github.com/wolvespack/alcor.git

  cd alcor

  python3 setup.py install

Bumping version

---------------

Install `bumpversion `__.

Choose which version number category to bump following `semver specification `__.

Test bumping version

.. code-block:: bash

    bumpversion --dry-run --verbose $VERSION

where ``$VERSION`` is the target version number category name,

possible values are ``patch``/``minor``/``major``.

Bump version

.. code-block:: bash

    bumpversion --verbose $VERSION

**Note**: to avoid inconsistency between branches and pull requests,

bumping version should be merged into ``master`` branch as separate pull request.

Running tests

-------------

Plain

.. code-block:: bash

    python3 setup.py test

Inside ``Docker`` container

.. code-block:: bash

    docker-compose up

Inside ``Docker`` container with remote debugger

.. code-block:: bash

    ./set-dockerhost.sh docker-compose up

Bash script (e.g. can be used in ``Git`` hooks)

.. code-block:: bash

    ./run-tests.sh