Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write flows using fedelemflowlist #111

Merged
merged 6 commits into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions lciafmt/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -129,11 +129,13 @@ def clear_cache():
cache.clear()


def to_jsonld(df: pd.DataFrame, zip_file: str, write_flows=False):
def to_jsonld(df: pd.DataFrame, zip_file: str, write_flows=False, **kwargs):
"""Generate a JSONLD file of the methods passed as DataFrame."""
util.log.info(f"write JSON-LD package to {zip_file}")
with jsonld.Writer(zip_file) as w:
w.write(df, write_flows)
w.write(df, write_flows,
preferred_only=kwargs.get('preferred_only', False),
)


def map_flows(df: pd.DataFrame, system=None, mapping=None,
Expand Down
14 changes: 12 additions & 2 deletions lciafmt/jsonld.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

from esupy.util import make_uuid
from esupy.bibtex import generate_sources
import fedelemflowlist
from .util import is_non_empty_str, generate_method_description,\
log, pkg_version_number, datapath, check_as_class

Expand All @@ -39,7 +40,7 @@ def __enter__(self):
def __exit__(self, exc_type, exc_val, exc_tb):
self.__writer.close()

def write(self, df: pd.DataFrame, write_flows=False):
def write(self, df: pd.DataFrame, write_flows=False, preferred_only=False):
if 'source_method' not in df:
df['source_method'] = df['Method']
if 'source_indicator' not in df:
Expand Down Expand Up @@ -72,7 +73,16 @@ def write(self, df: pd.DataFrame, write_flows=False):
self.__sources
]
if write_flows:
dicts.append(self.__flows)
log.info("writing flows from the fedelemflowlist ...")
flowlist = fedelemflowlist.get_flows(preferred_only)
flow_dict = self.__flows
flows = flowlist.query('`Flow UUID` in @flow_dict.keys()')
if preferred_only:
log.info("writing only preferred flows ...")
elif len(flows) != len(flow_dict):
log.warning("not all flows written...")
fedelemflowlist.write_jsonld(flows, path=None,
zw = self.__writer)
for d in dicts:
for v in d.values():
self.__writer.write(v)
Expand Down
8 changes: 5 additions & 3 deletions lciafmt/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,8 @@ def download_method(method_id):
download_from_remote(meta, paths)


def save_json(method_id, mapped_data, method=None, name='', write_flows=False):
def save_json(method_id, mapped_data, method=None, name='',
write_flows=False, **kwargs):
"""Save a method as json file in the outputpath.

:param method_id: class Method
Expand All @@ -288,12 +289,13 @@ def save_json(method_id, mapped_data, method=None, name='', write_flows=False):
filename = name
if method is not None:
filename = method.replace('/', '_')
mapped_data = mapped_data[mapped_data['Method'] == method]
mapped_data = mapped_data.query('Method == @method').reset_index(drop=True)
path = OUTPUTPATH / meta.category
mkdir_if_missing(OUTPUTPATH)
json_pack = path / f'{filename}_json_v{meta.tool_version}.zip'
json_pack.unlink(missing_ok=True)
lciafmt.to_jsonld(mapped_data, json_pack, write_flows=write_flows)
lciafmt.to_jsonld(mapped_data, json_pack, write_flows=write_flows,
**kwargs)


def compare_to_remote(local_df, method_id):
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
package_data={'lciafmt': ["data/*.*"]},
include_package_data=True,
python_requires=">=3.9",
install_requires=["fedelemflowlist @ git+https://github.com/USEPA/fedelemflowlist.git@develop#egg=fedelemflowlist",
install_requires=["fedelemflowlist @ git+https://github.com/USEPA/fedelemflowlist.git@write_flows#egg=fedelemflowlist",
"esupy @ git+https://github.com/USEPA/esupy.git@develop#egg=esupy",
"olca-schema>=0.0.11",
"pandas>=0.22",
Expand Down
3 changes: 2 additions & 1 deletion tests/test_generate_methods.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ def test_method_write_json():
lciafmt.util.save_json(method_id = method_id,
name = 'test_TRACI',
mapped_data = method,
write_flows=True)
write_flows=True,
preferred_only=True)
# Test FEDEFL Inventory
method_id = lciafmt.Method.FEDEFL_INV
method = lciafmt.get_mapped_method(method_id = method_id,
Expand Down
Loading