icra / ecoinvent Goto Github PK

Ecoinvent web tool for wastewater (Lluís Bosch, Lluís Corominas, Pascal Lesage, George Ekama, Yves Comeau)

Home Page: http://prqv.vps.infomaniak.com/ecoinvent/

JavaScript 3.75% PHP 96.09% CSS 0.04% Shell 0.06% Python 0.06%

ecoinvent's Introduction

ICRA

The Catalan Institute for Water Research (ICRA-CERCA) is an international reference center that focuses research of the integral water cycle, hydraulic resources, water quality (in the broadest sense of the term: chemical, microbiological, ecological, etc.) and treatment and evaluation technologies, and to transfer this knowledge to society and business network.

The ICRA-CERCA was created on 26 October 2006 by the Government of Catalonia within the framework of the Research Centres Programme of Catalonia (CERCA), and it is a Research Institute attached to the University of Girona (UdG), according to the Decree of the Government of Catalonia of 6 July 2018.

Purpose

This GitHub organization is intended to publicly host source code for applications and tools developed within the research activity of ICRA.

Instructions: Who Can Be a Member

Only ICRA staff can be a member of the ICRA org on github.com and release code in github.com/icra org.

Only members have rights to directly edit code in a github.com/icra repository. Everyone else will need to submit a pull request. We highly encourage pull requests from the public. However, please note that not all repositories are actively maintained.

Members of the public can not attain and do not need collaborator status. You don't need any special status to submit pull requests or add issues.

Instructions: Once You Are a Member

To ensure mandatory policies are followed, ICRA org members are not given the full admin rights you might be used to on your personal github.com accounts. However, by using teams, team owners, collaborators, and outside collaborators roles we can make the experience pretty quick and easy.

Org owners

We currently have one active owner in the org:

Lluís Bosch ([email protected])

Repos

We do not give out admin rights on any ICRA Github repos for reasons stated above. If you want a new repo created or want to edit settings on an existing repo that require admin access, please contact one of our org owners. Without admin rights on a repository, you'll still be able to make any code changes yourself as long as you're a collaborator on that repository or a member of a team whose participants are collaborators by default.

Teams

Teams are effective ways of managing repository access privileges for an entire group of users. Only org owners can create and remove teams, but we now allow users to be team maintainers. Team maintainers have permissions to add and remove users to their teams from the population of people who are already ICRA org members.

Collaborators

Github also has a role called "collaborator". This is someone who doesn't have repository ownership or admin rights but can push edits to code directly without doing a pull request.

If you would like to add a ICRA staff member who is a member of the ICRA org as a collaborator on a single repository, we still suggest you contact the ICRA org owners mentioned above about setting up a TEAM for that single repository instead of adding people one by one. Teams result in less requests (and therefore waiting) on ICRA org owners for actions. We are sorry you don't have normal full ownership rights. It is because everyone with write access needs to be approved ICRA user. If you had normal repository owner right, you could add any github user.

Outside Collaborators

Only on a rare case-by-case basis we will allow non-ICRA users to be added to the org as Outside Collaborators. You can collaborate without this status via forks, branches, and pull-requests. If you fork a repository, you can make changes and then submit back a pull-request. A repository maintainer can then approve those changes. You do not need formal outside-collaborator status for this!

Please reach out to us if you have any questions.

Common Requests

Contact our org owners:

If you need to be added to the ICRA org on github.com
If you need to create a new team for managing who has access to make changes on a particular repository or group of repositories.
If you need to add a new member to an already established team.

Related Sites

Organizationally Related Sites

Other ICRA orgs on github.com or gitlab.com or bitbucket

Although ICRA staff are highly encouraged to release open source software on github.com/icra as that is where most people look so it ensures higher potential reuse, they are not absolutely required to use that org account. A common reason code may exist under other orgs is that the software is jointly maintained by non-ICRA persons or the code was developed by non-ICRA persons through a ICRA grant.

To encourage discoverability, please use the #ICRA topic tag on any GitHub or GitLab repositories not under github.com/icra.

Discovering useful ICRA Open-Source Code via metadata catalogs

There are several ICRA open-source code repositories and as previously noted, not everything is on github.com/icra. To improve your chance of finding something useful to you, we suggest you use itlab.icra.cat. This site hosts metadata descriptions for nearly all of the officially open-sourced code.

ICRA github only shows open-source software. For government-source and patented software, see itlab.icra.cat.

Please make sure any repos added to github.com/icra are also featured in itlab.icra.cat!

The information on itlab.icra.cat is presented in a way that leverages ICRA's technology taxonomy, so if you want to see an aggregate view of ICRA software categories, it is a good place to visit.

It also includes some older software products that are only available as downloadable zip files as well as software that must be requested individually as they might be tied to a patent.

Questions?

In addition to the emails listed above, you may leave an issue on this repository. We will use those questions & answers to eventually make a FAQ section on this page.

ecoinvent's People

Contributors

Watchers

Forkers

annavalls

ecoinvent's Issues

Chnage text in Homepage

USE THIS TEXT
The main purpose of the ecoinvent wastewater treatment tool is to generate datasets representing treatment of wastewater with specific composition using specific type of treatment. For more detailed information on the type of methodology used behind this tool, please see the Methodological Report (see the link below).

This tool has been developed within the SRI project and is accessible for free to everybody.

Depending on the context, datasets are generated for the treatment of the wastewater in wastewater treatment plants (WWTP) and for wastewater that is directly discharged to the environment. For the treated fraction, the tool calculates the life cycle inventory of a WWTP (or a set of WWTP) with and without the input of the wastewater for which the datasets are generated, and bases the wastewater-specific life cycle inventory on the difference between the two simulations.

The steps for using the tool are:
1) Data entry: Enter information about the wastewater of interest: the nature and location of its source, its contamination levels, etc.
2) Calculation dashboard: Enter or modify the data on the wastewater treatment plants where the wastewater is being treated. The tool will calculate life cycle inventories for the WWTP operating with and without the input of the wastewater.
3) Generate datasets: The model outputs are converted into datasets, downloadable in ecoSpold2 format.

** AND NO LONGER THIS TEXT**
The ecoinvent wastewater tool was developed to generate ecoinvent-compliant datasets for wastewater that is discharged to the sewer system. It is useful both for data providers that need to supply datasets on the fate of wastewater from the activity they are submitting data for, and for LCA modellers specifically interested in wastewater treatment.

The steps for using the tool are:
Data entry: Enter information about the wastewater of interest: the nature and location of its source, its contamination levels, etc.
Calculation dashboard: Enter or modify the data on the wastewater treatment plants where the wastewater is being treated. The tool will calculate life cycle inventories for the WWTP operating with and without the input of the wastewater.
Generate datasets: The model outputs are converted into datasets, downloadable in ecoSpold format.

The datasets can then be submitted to ecoinvent for inclusion in the database. To do so, the ecoSpold files should be opened in the ecoEditor, checked, and then submitted directly via the ecoEditor.

Not all tech combinations should be possible to activate (like in single plant model)

Block BOD removal from being unchecked

N and P balances differ (L. Corominas equations vs G. Ekama equations)

Issue from April 20 2018

iSS composition can be calculated

iSS composition can be calculated as O+Si+Al+Fe+Ca+Na+K+Mg.

the percentages are in 'sludge_composition.js'

George provided this info April 16 2018

Simplified data entry

The ‘Simplified data entry’: is this menu useful for both simulations of single plants and multiple plants? In point 6 it looks like it is only relevant for multiple plant simulation. The user should be given instructions.

Consider adding NO3 (or NOx) as an input, not only a calculated variable

A new input "NOx" (g/m3) with default value as "0 g/m3" could be included.

NOx is a calculated variable, but it is possible in some cases that there is NOx in the influent

the ‘Implementation’ button in many modules seems to fail, leading to a blank page

For example: in Complete-Mix AS for BOD removal with Nitrification

"Ecospold output file generation"

The section ‘4. Ecospold output file generation’, which output is this feature using in order to generate the spold file, if I have been calculating LCIs in both multiple plant model and single plant model?

Code includes notes directly taken from emails

Modules 10, 11, 12 (maybe in others too): the code includes notes directly taken from emails. I guess this kind of background information, assumptions, etc. could be
placed as part of the written content that one can access through the different links in the ‘Source’ column. The people communicating this information, e.g. George Ekama, should have a reference somewhere (who he is, his position and where).

Create Warnings

Add warnings:

fSus (raw: 0% to 10%. with primary settler: 0% to 15%)
fSup (raw: 8% to 25%. with primary settler: 0% to 10%)
difference_NOr_NOx (in denitrification) < 5%

Dewatering polymer

The simulation gives an estimate of dewatering polymer under ‘Chemicals (5)’, but I haven’t seen any background information or code for this calculation?

On the IT side of things; is there some documentation on the web tool architecture?

Update text in GEnerating ecoSpold2 files

USE THIS TEXT

The generated datasets are in the ecoSpold2 format (.xml). This type of files can be either opened in the ecoEditor (freeware published by ecoinvent), imported into MS Excel, imported into LCA software tools which support import of ecoSpold2 format, opened using XML editor or processed using different types of programming languages (e.g. Python).

AND NO LONGER THIS TEXT

The ecoSpold file(s) can be downloaded. To submit the datasets to ecoinvent:
Make sure you have installed the ecoEditor freeware and created an account (Menu → Extras → Account management → Register data provider account)
Open the ecoSpold2 files in the ecoEditor.
Manually revise the datasets to make sure the fields are correctly filled out. A list of fields to be especially attentive to is given in the methodological report, section 8.3.
Use ecoEditor to "validate" the datasets (Menu → File → Validate). This will carry out mass balances and make sure all expected fields are filled out.
Submit the datasets for an external validation (Menu → File → Submit Datasets for Validation). Routines on the ecoinvent server will ensure that the dataset can indeed "fit" in the database.
Once successful with the previous steps, the datasets can be submitted for review (Menu → File → Submit Datasets for Review). Editors from the ecoinvent editorial board will then review the datasets to make sure they are ok for submission.

Note that if the wastewater treatment datasets were generated in order to have treatment datasets for some other activity, the wastewater treatment datasets should be submitted at the same time or before the other activity, but not after.

Importing to ecoeditor

I created spold files and successfully imported them to Ecoeditor. While using the model the user is not warned of the direct discharge data set that is created together with the one for treatment. This is a bit strange unless you have read the manual where this is explained. I think the tool should inform of this as well.

Add a button to Recalculate yves estimations

TOC & DOC

influent, effluent calculations and C balance

TBD

BOD effluent equation

Done in the tool only but not in ecospold

Tereza's observations

Overall it is visible, you did lot of work. But the user friendliness is still missing. Consider, that people have to be able to use the tool without any class or introduction from us. The user needs to always understand what is she/he looking at and what should she/he do.

Home page: I would really recommend to include an introduction page, where you describe (in as simple and clear way as possible) what the tool is and what it does and how it can be used. Describe also the individual steps of the procedure: 1) Simplified data entry; the first step of creating a dataset on treatment of wastewater is to enter the composition of the wastewater which should be treated …. The home page should also include link to the report in a very visible way. At this point if you access the tool you simple do not know what to do.

I can see, that you included a lot of instructions in the report. It would be good to consider incorporating some of it directly in the tool.

Please consider renaming the “Web parts”. I would expect something like “Steps of dataset generation”.

Please include clear explanation for every step of the dataset generation process. For example when the user enters the Multiple plant simulation site … what is it? What does it do? What is the user expected to do? Consider including short paragraph with explanation.

Please include somewhere a mention on what to do with the ecoSpold2 file …. that the ecoSpold2 file is actually xml format of a file and it can be either opened in the ecoeditor, worked on using Python or imported into excel.

Modules implemented; again here you have to be very clear on what does this part represent. You should clearly say, that this is an additional information the user can have a look at, but does not have to if she/he wants to simply generate a dataset. It is great, that even the links to the specific parts of the code are available, but it should be very clear what is this information for.

I assume, that you will remove some things at the end, which are present in the tool at the moment. For example the “See all TO DO items”.

Other things; will this part stay as it is also for the users? It seems to me some of these things could be included in the “Modules implemented”. Fractionation is, for example, in both places.

Other things; Documents section does not work at the moment.

On the IT side of things; is there some documentation on the web tool architecture?

add mixing energy for anaerobic reactors, similarly to anoxic reactors

The link to G. Doka excel tool seems to be broken.

https://prqv.vps.infomaniak.com/ecoinvent/docs/gabor-doka-tool/

In ‘Multiple plant model’, when choosing to normalize results for 1 m3, the units still appear as kg/d,

In the mode ‘Single plant model’ I see how to run calculations, but I cannot find the option to create a spold file.

Comments on "Other things" section

The section ‘Documents’ seems to have a broken link.
In the section ‘Fractionation’, the footnote “Note: Implementing it here separately will make it easier later to integrate with the rest of the code”. Is this a note for the user? If I was a user I would not know what to make of it.
Section ‘Influent default data by country’: not clear what this information is. Does the user need to modify these data?
‘Summary of terms’: I miss other abbreviations such as RAS, OTR... also, since the list is long, it could be ordered in alphabetical order.
‘BOD removal (simple example) M&EA 4th (p. 707)’: why is this example here. Isn’t this the same example shown in ‘Modules implemented’, in modules 1, 2, etc.?

Warning sign (in multiple plant simulation)

According to the report, the Warning sign in the wastewater composition is expected to re calculate if you change some of the parameters like COD, etc. However, this did not work when I tried.

Add more technologies (Lagoons)

Morera reference under ‘Construction materials’ has a broken link

The aspect of the ‘Statement’ section, with scanned content from the M&EA book is not ideal. Also, could there be copyright issues with having these images here

Coarse solids removal equations

It is a formula that depends only on the flowrate (Q)

About construction materials

About the construction materials, the user could be given some advice on what to do if the WWTP is larger than 21000 m3/day. In the report the Girona WWTP data are described for large plants, but it does not seem to have been implemented?