feat!: qualitative enrichment (#39)

add new QualitativeEnrichment class, for adding category features to a synthetic population
renamed enrichment modules and classes for more consistency (quantitative or qualitative)
refactor analysis functions into classes (needed because some code is different between quantitative and qualitative analysis (plots, ..)). See examples or tests for new usage.

.github/workflows/tests.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Install dependencies
         run: |
           python3 -m pip install --upgrade pip
-          python3 -m pip install pytest
+          python3 -m pip install pytest kaleido
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
 
       - name: Test with pytest

.gitignore

@@ -138,8 +138,8 @@ dmypy.json
 *.html
 *_files/
 
-# analysis plots
-/plots
+# analysis outputs
+/outputs
 
 # test tmp folder
 tests/tmp/

README.md

@@ -32,7 +32,7 @@ pip install bhepop2
 
 ## Example
 
-See this example [Notebook](examples/demo.ipynb).
+See example notebooks [here](examples).
 
 ## Documentation
 

bhepop2/__init__.py

@@ -5,7 +5,7 @@
 #: bhepop2 version
 __version__ = "0.1.4"
 
-# from bhepop2.bhepop2_enrichment import Bhepop2Enrichment
+# from bhepop2.bhepop2_enrichment import QuantitativeEnrichment
 #
 #
 # # enrichment functions (avoids direct use of classes)
@@ -23,7 +23,7 @@
 #     :return: enriched population
 #     """
 #     # create enrichment class instance
-#     enrich_class = Bhepop2Enrichment(
+#     enrich_class = QuantitativeEnrichment(
 #         population,
 #         distributions,
 #         attribute_selection=attribute_selection,