Added cpp extensions, tests, hooks cpp and markdown linters; removed …

…poetry, added setuptools; massive cleanups; updated README.md; bumped version

.gitignore

@@ -1,4 +1,5 @@
 test_examples/
+.vscode
 
 ### List below was sourced from <https://github.com/github/gitignore/blob/main/Python.gitignore>
 

.pre-commit-config.yaml

@@ -23,4 +23,16 @@ repos:
   - id: MkDocsbuild
     name: Building the markdown documentation with `mkdocs build`
     entry: bash -c 'mkdocs build'
-    language: system
+    language: system
+
+- repo: https://github.com/pre-commit/mirrors-clang-format
+  rev: v17.0.6
+  hooks:
+  - id: clang-format
+    args: [--style=LLVM]
+
+- repo: https://github.com/DavidAnson/markdownlint-cli2
+  rev: v0.12.1
+  hooks:
+  - id: markdownlint-cli2
+    args: [--fix]

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include extern *

README.md

@@ -1,9 +1,50 @@
 # BrahMap
 
-An optimal map-making package for LiteBIRD, based on [COSMOMAP2](https://github.com/giuspugl/COSMOMAP2), described in [*Puglisi et al (2018)*](https://doi.org/10.1051/0004-6361/201832710)
+<!-- markdownlint-disable MD033 -->
+<font color="red"> **This project is currently under active development!!!** </font>
+<!-- markdownlint-disable MD033 -->
 
-[Documentation](https://anand-avinash.github.io/BrahMap/)
+`BrahMap` is an optimal map-making framework for the future CMB experiments,
+based on [COSMOMAP2](https://github.com/giuspugl/COSMOMAP2), as described in
+[*Puglisi et al (2018)*](https://doi.org/10.1051/0004-6361/201832710).
 
-After cloning for the first time, run `pre-commit install`.
+`BrahMap` is written Python with C++ extension handling the heavy computation.
+It implements GLS map-making with PCG solver, taking into account the
+block-band diagonal noise correlation matrix. This implementation offers
+solvers of I, QU, and IQU maps.
 
-<font color="red"> UNDER DEVELOPMENT!!! </font>
+Go to the [quick start guide](quick_start.md) for a quick introduction to
+map-making with `BrahMap`. Refer to the [API reference](api_references.md)
+for a completer reference to `BrahMap` API.
+
+## Installation
+
+`BrahMap` can be installed with the following steps:
+
+```shell
+# Clone the repository
+git clone https://github.com/anand-avinash/BrahMap.git
+
+cd BrahMap
+
+# Install the package
+pip install .
+
+# Alternatively, do an editable installation for development purpose
+# followed by `pre-commit` install
+pip install -e .
+pre-commit install
+```
+
+### Notes
+
+`BrahMap` uses [Setuptools](https://setuptools.pypa.io/en/latest/index.html)
+to build the C++ extensions. By default, it creates the command for compilation
+by collecting
+[several environment variables](https://setuptools.pypa.io/en/latest/index.html).
+To change the compiler for the building the C++ extension, supply the
+compiler name via `CC` or `CXX` variables:
+
+```shell
+CC=clang++ pip install .
+```

brahmap/__init__.py

@@ -1,7 +1,3 @@
-# from .interfaces import *
-# from .utilities import *
-# from .linop import *
-
 from . import interfaces, utilities, linop
 
 __all__ = [

brahmap/interfaces/__init__.py

@@ -1,45 +1,17 @@
-from .deflationlib import (
-    arnoldi,
-    build_hess,
-    build_Z,
-    run_krypy_arnoldi,
-    find_ritz_eigenvalues,
-)
 from .linearoperators import (
-    GroundFilterLO,
-    calculate,
-    calculatestar,
-    FilterLO,
-    globalprocsfilter,
     SparseLO,
     ToeplitzLO,
-    WeightingLO,
     BlockLO,
     BlockDiagonalLO,
     BlockDiagonalPreconditionerLO,
     InverseLO,
-    CoarseLO,
-    DeflationLO,
 )
 
 __all__ = [
-    "arnoldi",
-    "build_hess",
-    "build_Z",
-    "run_krypy_arnoldi",
-    "find_ritz_eigenvalues",
-    "GroundFilterLO",
-    "calculate",
-    "calculatestar",
-    "FilterLO",
-    "globalprocsfilter",
     "SparseLO",
     "ToeplitzLO",
-    "WeightingLO",
     "BlockLO",
     "BlockDiagonalLO",
     "BlockDiagonalPreconditionerLO",
     "InverseLO",
-    "CoarseLO",
-    "DeflationLO",
 ]