Skip to content

Commit

Permalink
Merge branch 'master' into HLA-1111_updated_hap_svm_filenames_09_28_23
Browse files Browse the repository at this point in the history
  • Loading branch information
s-goldman authored Oct 5, 2023
2 parents a71cc98 + 06c2787 commit e0eac54
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 8 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Drizzlepac

[![Build Status](https://dev.azure.com/spacetelescope/drizzlepac/_apis/build/status/spacetelescope.drizzlepac?branchName=master)](https://dev.azure.com/spacetelescope/drizzlepac/_build/latest?definitionId=2&branchName=master)
[![Build Status](https://ssbjenkins.stsci.edu/job/STScI/job/drizzlepac/job/master/badge/icon)](https://ssbjenkins.stsci.edu/job/STScI/job/drizzlepac/job/master/)
[![Build Status](https://github.com/spacetelescope/drizzlepac/actions/workflows/ci.yml/badge.svg)](https://github.com/spacetelescope/drizzlepac/actions/workflows/ci.yml)
[![Documentation Status](https://readthedocs.org/projects/drizzlepac/badge/?version=latest)](http://drizzlepac.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/spacetelescope/drizzlepac/branch/master/graph/badge.svg)](https://codecov.io/gh/spacetelescope/drizzlepac)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3743274.svg)](https://doi.org/10.5281/zenodo.3743274)
Expand All @@ -23,10 +22,7 @@ can be found at:

## Conda (Recommended)

```bash
$ conda config --add channels http://ssb.stsci.edu/astroconda
$ conda create -n astroconda stsci
```
`Drizzlepac` is installed when you install the `stenv` conda environment (a replacement for `astroconda`). Select your desired release and follow the instructions on the [`stenv` installation page](https://stenv.readthedocs.io/en/latest/getting_started.html).

## From Source

Expand Down
45 changes: 44 additions & 1 deletion doc/source/getting_started/installation.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,47 @@
Installation
------------

*Coming soon!*
Conda (Recommended)
===================

``Drizzlepac`` is installed when you install the ``stenv`` conda environment (a replacement for ``astroconda``). Select your desired release and follow the instructions on the `installation page <https://stenv.readthedocs.io/en/latest/getting_started.html>`_.


From Source
===========

Clone this repository
*********************
.. code-block:: shell
git clone https://github.com/spacetelescope/drizzlepac
cd drizzlepac
Build the documentation
=======================

*Note:* If you intend to use ``drizzlepac``'s embedded help feature from within
an interactive ``python`` or ``ipython`` session, we recommend you do not skip
this step.


.. code-block:: shell
cd doc/
make html
Install drizzlepac
==================

.. code-block:: shell
pip install .
The option ``--no-use-pep517`` MAY be required in order to correctly build
the C extensions with ``pip`` versions up to 22.2, after commenting out
the ``build-backend`` from the ``pyproject.toml`` config file.

**Support for installing using `pip` is still evolving, so use of this
command is provided on an experimental basis for now.**
2 changes: 1 addition & 1 deletion drizzlepac/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -1174,7 +1174,7 @@ def base_taskname(taskname, packagename=None):
----------
taskname : str, None
Full task name. If it is ``None``, :py:func:`base_taskname` will
return ``None``\ .
return ``None`` .
packagename : str, None (Default = None)
Package name. It is assumed that a compound task name is formed by
Expand Down

0 comments on commit e0eac54

Please sign in to comment.