Merge pull request #64 from C2SM-RCM/master

Update with the most recent code

.github/workflows/python-package.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.9", "3.12"]
 
     steps:
     - uses: actions/checkout@v3

.readthedocs.yaml

@@ -14,7 +14,7 @@ build:
     # Required by cartopy
     - libgeos-dev
   tools:
-    python: "3.10"
+    python: "3.12"
     # You can also specify other tool versions:
     # nodejs: "16"
     # rust: "1.55"

README.md

@@ -13,6 +13,4 @@ The full documentation is hosted at https://emiproc.readthedocs.io .
 
 ## License
 
-This work is licensed under the Creative Commons Attribution 4.0 International License.
-To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/ or
-send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.
+This work is licensed under a BSD-3-Clause licence. See the LICENSE file for details or https://opensource.org/license/bsd-3-clause

docs/source/api/categories.rst

@@ -0,0 +1,6 @@
+Categories Manipulations 
+========================
+
+.. autofunction:: emiproc.inventories.utils.validate_group
+
+.. autofunction:: emiproc.inventories.utils.group_categories

docs/source/api/exports.rst

@@ -0,0 +1,26 @@
+Exporting 
+=========
+
+.. autofunction:: emiproc.exports.netcdf.nc_cf_attributes
+
+.. autofunction:: emiproc.exports.icon.export_icon_oem
+
+.. autofunction:: emiproc.exports.icon.make_icon_time_profiles
+
+.. autofunction:: emiproc.exports.icon.make_icon_vertical_profiles
+
+.. autoenum:: emiproc.exports.icon.TemporalProfilesTypes
+
+.. autofunction:: emiproc.exports.rasters.export_raster_netcdf
+
+.. autofunction:: emiproc.exports.profiles.export_inventory_profiles
+
+.. autofunction:: emiproc.exports.utils.get_temporally_scaled_array
+
+.. autofunction:: emiproc.exports.wrf.export_wrf_hourly_emissions
+
+
+Gral
+----
+.. automodule:: emiproc.exports.gral
+    :members:

docs/source/api/grids.rst

@@ -0,0 +1,19 @@
+Grid Class
+==========
+
+General Grids 
+^^^^^^^^^^^^^
+
+.. autoclass:: emiproc.grids.Grid
+
+.. autoclass:: emiproc.grids.RegularGrid
+
+.. autoclass:: emiproc.grids.GeoPandasGrid
+
+
+Model Grids 
+^^^^^^^^^^^
+
+.. autoclass:: emiproc.exports.wrf.WRF_Grid
+
+.. autoclass:: emiproc.grids.ICONGrid

docs/source/api/index.rst

@@ -0,0 +1,21 @@
+===
+API 
+===
+
+All the code of emiproc is there. 
+
+
+.. toctree::
+    :maxdepth: 2
+
+    inventories
+    grids 
+    categories
+    speciation
+    operators
+    profiles
+    models
+    exports
+    utilities
+
+

docs/source/api/inventories.rst

@@ -0,0 +1,47 @@
+Inventories
+===========
+
+
+Inventory Class
+---------------
+
+.. autoclass:: emiproc.inventories.Inventory
+    :members:
+
+
+Available Inventories 
+---------------------
+
+.. autoclass:: emiproc.inventories.tno.TNO_Inventory
+    :special-members: __init__
+
+.. autofunction:: emiproc.inventories.tno.read_tno_gridded_profiles
+
+.. autoclass:: emiproc.inventories.edgar.EDGAR_Inventory
+    :special-members: __init__
+
+.. autoclass:: emiproc.inventories.swiss.SwissRasters
+    :special-members: __init__
+
+.. autofunction:: emiproc.inventories.swiss.read_prtr
+
+.. autoclass:: emiproc.inventories.zurich.MapLuftZurich
+    :special-members: __init__
+
+.. autoclass:: emiproc.inventories.EmiprocNetCDF
+    :special-members: __init__
+
+.. autoclass:: emiproc.inventories.gfas.GFAS_Inventory
+    :special-members: __init__
+
+.. autoclass:: emiproc.inventories.gfed.GFED4_Inventory
+    :special-members: __init__
+
+.. autoclass:: emiproc.inventories.lpjguess.LPJ_GUESS_Inventory
+    :special-members: __init__
+
+.. autoclass:: emiproc.inventories.saunois.SaunoisInventory
+    :special-members: __init__
+
+.. autoclass:: emiproc.inventories.gral.GralInventory
+    :special-members: __init__

docs/source/api/models.rst

@@ -0,0 +1,24 @@
+Emission models
+===============
+
+Functions that can be used to generate some parts of inventory data.
+
+Heating Degree Days (HDD)
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. automodule:: emiproc.profiles.hdd
+    :members:
+
+
+Human Respiration 
+^^^^^^^^^^^^^^^^^ 
+
+.. automodule:: emiproc.human_respiration
+    :members:
+
+
+VPRM 
+^^^^
+
+.. automodule:: emiproc.profiles.vprm
+    :members: