perform general housekeeping pre-release

CosmoMatt · CosmoMatt · commit 642f61306b83 · 2021-11-30T18:38:32.000Z
diff --git a/.github/workflows/cpp.yml b/.github/workflows/cpp.yml
@@ -1,4 +1,4 @@
-name: Flaglet-C
+name: Tests
 
 on: [push]
 
@@ -18,10 +18,6 @@ jobs:
     steps:
     - name: Configure Flag permissions
       uses: actions/checkout@v2
-      # with:
-      #   repository: astro-informatics/src_flag
-      #   ref: refs/heads/bintray_sunsetting
-      #   token: ${{ secrets.ACCESS_TOKEN }}
 
     - name: Set up Python 3.8
       uses: actions/setup-python@v2
@@ -39,7 +35,7 @@ jobs:
       run: |
         cd ${{runner.workspace}}
         cd ..
-        git clone --branch bintray_sunsetting https://${{ secrets.ACCESS_TOKEN }}:x-oauth-basic@github.com/astro-informatics/src_flag.git
+        git clone --branch master https://${{ secrets.ACCESS_TOKEN }}:x-oauth-basic@github.com/astro-informatics/src_flag.git
         cd src_flag && mkdir build && cd build
         cmake ../ && make && 
         sudo make install 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,10 +1,10 @@
-cmake_minimum_required(VERSION 3.12)
+cmake_minimum_required(VERSION 3.15)
 
 project(
   flaglet
-  VERSION "0.0.1"
+  VERSION "1.0.0"
   DESCRIPTION "Fast wavelets on the ball"
-  HOMEPAGE_URL "https://github.com/astro-informatics/flaglet"
+  HOMEPAGE_URL "https://github.com/astro-informatics/src_flaglet"
   LANGUAGES C)
 
 option(tests "Enable testing" ON)
diff --git a/README b/README
diff --git a/README.rst b/README.rst
@@ -1,35 +1,51 @@
-***********************************************
-FLAGLET: Fourier-Laguerre Wavelets on the Ball
-***********************************************
-
 .. image:: https://img.shields.io/badge/GitHub-src_flaglet-brightgreen.svg?style=flat
     :target: https://github.com/astro-informatics/src_flaglet
-
 .. image:: https://github.com/astro-informatics/src_flaglet/actions/workflows/cpp.yml/badge.svg
     :target: https://github.com/astro-informatics/src_flaglet/actions/workflows/cpp.yml
-
 .. image:: https://readthedocs.org/projects/ansicolortags/badge/?version=latest
-    :target: https://astro-informatics.github.io/src_flaglet/
-
+    :target: https://astro-informatics.github.io/flaglet/
 .. image:: https://img.shields.io/badge/License-GPL-blue.svg
     :target: http://perso.crans.org/besson/LICENSE.html
-
 .. image:: http://img.shields.io/badge/arXiv-1205.0792-orange.svg?style=flat
     :target: https://arxiv.org/abs/1205.0792
-
 .. image:: http://img.shields.io/badge/arXiv-1110.6298-orange.svg?style=flat
     :target: https://arxiv.org/abs/1110.6298
-
 .. image:: http://img.shields.io/badge/arXiv-2105.05518-orange.svg?style=flat
     :target: https://arxiv.org/abs/2105.05518
 
+|logo| FLAGLET: Fourier-Laguerre Wavelets on the Ball
+=====================================================
+
+.. |logo| raw:: html
+
+   <img src="./doc/images/logo.png" align="center" height="52" width="58">
+
 DESCRIPTION
 ================================
-The FLAGLET code provides functionality to perform fast and exact wavelet transform on the ball. More details may be found in the extensive `documentation <https://astro-informatics.github.io/flaglet/>`_.
+The ``FLAGLET`` code provides functionality to perform fast and exact wavelet transform on the ball. More details may be found in the extensive `documentation <https://astro-informatics.github.io/flaglet/>`_.
 
-INSTALLATION
+C INSTALLATION
 ================================
-This package can easily be installed from PyPi by running
+The primary C version of this code can be installed from source by running
+
+.. code-block:: bash
+
+     git clone git@github.com:astro-informatics/src_flaglet.git
+     cd src_flaglet
+     mkdir build && cd build
+     cmake .. && make 
+
+Following which one can check the installation by running
+
+.. code-block:: bash
+
+     ctest
+
+within the build directory.
+
+PYTHNON INSTALLATION
+================================
+``FLAGLET`` can easily be installed from PyPi by running
 
 .. code-block:: bash
 
@@ -42,11 +58,21 @@ or alternatively from source by first compiling the C++ code and running
 
     pip install .
 
+from the root directory, following which the installation can be tested by running 
+
+.. code-block:: bash 
+
+     pytest 
+
 from the root directory.
 
+MATLAB INSTALLATION
+================================
+Mex wrappers are available, however they are currently being sunsetted, so installing previously tagged versions is advised.
+
 BASIC USAGE
 ================================
-First install flag for python, then you can call it from any python script to perform forward and inverse flag transforms and their adjoints by 
+First install ``FLAGLET`` for python, then you can call it from any python script to perform forward and inverse flaglet transforms and their adjoints by 
 
 .. code-block:: python
 
@@ -61,7 +87,7 @@ First install flag for python, then you can call it from any python script to pe
     f = rng.normal(size=(f_size)) + 1j*rng.normal(size=(f_size))
 
     # Compute e.g. the Forward transform 
-    f_wav_input, f_scal_input = flaglet.flaglet_ana(f, parameters)
+    f_wav, f_scal = flaglet.flaglet_forward(f, parameters)
 
 AUTHORS
 ================================
@@ -159,8 +185,12 @@ REFERENCES
 LICENSE
 ================================
 
-     FLAG package to perform fast wavelet transform on the sphere<br>
-     Copyright (C) 2012 Boris Leistedt & Jason McEwen
+``FLAGLET`` is released under the GPL-3 license (see `LICENSE.txt <https://github.com/astro-informatics/src_flaglet/blob/master/LICENSE.txt>`_).
+
+.. code-block::
+
+     FLAGLET package to perform fast wavelet transform on the sphere<br>
+     Copyright (C) 2021 Boris Leistedt & Jason McEwen & Matthew Price
 
      This program is free software; you can redistribute it and/or
      modify it under the terms of the GNU General Public License
diff --git a/conanfile.py b/conanfile.py
@@ -3,10 +3,10 @@
 
 class FlagletConan(ConanFile):
     name = "flaglet"
-    version = "0.0.1"
+    version = "1.0.0"
     license = "GPL-3"
-    url = "https://github.com/astro-informatics/flaglet"
-    homepage = "https://github.com/astro-informatics/flaglet"
+    url = "https://github.com/astro-informatics/src_flaglet"
+    homepage = "https://github.com/astro-informatics/src_flaglet"
     description = "Fast wavelet transform on the ball"
     settings = "os", "arch", "compiler", "build_type"
     topics = ("Physics", "Astrophysics", "Radio Interferometry")
diff --git a/include/flaglet_axisym.h b/include/flaglet_axisym.h
@@ -1,6 +1,6 @@
 // FLAGLET package
-// Copyright (C) 2012 
-// Boris Leistedt & Jason McEwen
+// Copyright (C) 2021
+// Boris Leistedt & Jason McEwen & Matthew Price
 
 #ifndef FLAGLET_AXISYM
 #define FLAGLET_AXISYM
diff --git a/include/flaglet_tiling.h b/include/flaglet_tiling.h
@@ -1,6 +1,6 @@
-// B3LET package
-// Copyright (C) 2012 
-// Boris Leistedt & Jason McEwen
+// FLAGLET package
+// Copyright (C) 2021
+// Boris Leistedt & Jason McEwen & Matthew Price
 
 #ifndef FLAGLET_TILING
 #define FLAGLET_TILING
diff --git a/include/flaglet_transform.h b/include/flaglet_transform.h
@@ -1,6 +1,6 @@
 // FLAGLET package
-// Copyright (C) 2012 
-// Boris Leistedt & Jason McEwen
+// Copyright (C) 2021
+// Boris Leistedt & Jason McEwen & Matthew Price
 
 #ifndef FLAGLET_TRANSFORM
 #define FLAGLET_TRANSFORM
diff --git a/include/flaglet_version.in.h b/include/flaglet_version.in.h
@@ -8,8 +8,9 @@ inline const char *flaglet_info() {
          "  authors:\n"
          "      - Boris Leistedt\n"
          "      - Jason McEwen\n"
+         "      - Matthew Price\n"
          "  license: GPL-3\n"
-         "  url: https://github.com/astro-informatics/flaglet\n"
+         "  url: https://github.com/astro-informatics/src_flaglet\n"
          "  version: @PROJECT_VERSION@\n";
 };
 // clang-format off
diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.0.1
+current_version = 1.0.0
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(rc(?P<rc>\d+))?
diff --git a/setup.py b/setup.py
@@ -9,7 +9,7 @@
 
 setup(
     name="pyflaglet",
-    version="0.0.1",
+    version="1.0.0",
     author="Boris Leistedt & Jason McEwen & Matthew Price",
     install_requires=["numpy", "cython", "scipy"],
     extras_require={
@@ -30,7 +30,7 @@
     description="Fast wavelet transform on the ball",
     long_description=long_description,
     long_description_content_type="text/x-rst",
-    url="https://github.com/astro-informatics/flaglet",
+    url="https://github.com/astro-informatics/src_flaglet",
     package_dir={"pyflaglet": "src/main/pyflaglet"},
     package_data={"pyflaglet": ["FLAGLET_Python_Documentation.rst"]},
     cmake_args=cmake_args,
diff --git a/src/main/c/flaglet_about.c b/src/main/c/flaglet_about.c
@@ -1,6 +1,6 @@
 // FLAGLET package
-// Copyright (C) 2012 
-// Boris Leistedt & Jason McEwen
+// Copyright (C) 2021
+// Boris Leistedt & Jason McEwen & Matthew Price
 
 /*! 
  * \file flaglet_about.c
diff --git a/src/main/c/flaglet_adjoint.c b/src/main/c/flaglet_adjoint.c
@@ -1,3 +1,7 @@
+// FLAGLET package
+// Copyright (C) 2021
+// Boris Leistedt & Jason McEwen & Matthew Price
+
 void flaglet_analysis_adjoint(complex double *f, const complex double *f_wav, const complex double *f_scal, const flaglet_parameters_t *parameters)
 {
 	double tau = parameters->tau;
diff --git a/src/main/c/flaglet_axisym.c b/src/main/c/flaglet_axisym.c
@@ -1,6 +1,6 @@
 // FLAGLET package
-// Copyright (C) 2012 
-// Boris Leistedt & Jason McEwen
+// Copyright (C) 2021
+// Boris Leistedt & Jason McEwen & Matthew Price
 
 #include "flaglet.h"
 #include <stdlib.h>
diff --git a/src/main/c/flaglet_tiling.c b/src/main/c/flaglet_tiling.c
@@ -1,6 +1,6 @@
 // FLAGLET package
-// Copyright (C) 2012 
-// Boris Leistedt & Jason McEwen
+// Copyright (C) 2021
+// Boris Leistedt & Jason McEwen & Matthew Price
 
 #include "flaglet.h"
 #include <stdlib.h>
diff --git a/src/main/c/flaglet_transform.c b/src/main/c/flaglet_transform.c
@@ -1,6 +1,6 @@
 // FLAGLET package
-// Copyright (C) 2012
-// Boris Leistedt & Jason McEwen
+// Copyright (C) 2021
+// Boris Leistedt & Jason McEwen & Matthew Price
 
 #include "flaglet.h"
 #include <stdlib.h>
diff --git a/src/main/pyflaglet/.FLAGLET_Python_Documentation.rst b/src/main/pyflaglet/.FLAGLET_Python_Documentation.rst
diff --git a/src/main/pyflaglet/bindings.pyx b/src/main/pyflaglet/bindings.pyx
diff --git a/src/test/pyflaglet/test_pyflaglet.py b/src/test/pyflaglet/test_pyflaglet.py
