Skip to content

Refactoring particleset creation method #39

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.

Sign up for GitHub

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

Merged
michaeldenes merged 4 commits into from
Jun 7, 2024
Merged

Refactoring particleset creation method #39

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e66a27b
Merge pull request #38 from OceanParcels/adding_new_tests
michaeldenes Jun 7, 2024
80e14b6
Refactored the create particleset functionality, so that users can pa…
michaeldenes Jun 7, 2024
e946f9b
Merge pull request #40 from OceanParcels/main
michaeldenes Jun 7, 2024
b195ac3
Changing from `zero_like` to `nan_like` in the `create_particleset()`…
michaeldenes Jun 7, 2024
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
102 changes: 63 additions & 39 deletions plasticparcels/constructors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,63 +202,32 @@ def create_fieldset(settings):
return fieldset


def create_particleset_from_map(fieldset, settings):
""" A constructor method to create a Parcels.ParticleSet for a plasticparcels simulation from one of the available initialisation maps
def create_particleset(fieldset, settings, release_locations):
""" A constructor method to create a Parcels.ParticleSet for a plasticparcels simulation

Parameters
----------
fieldset :
A Parcels.FieldSet object
settings :
A dictionary of model settings, simulation settings, and release settings and plastic-type settings
release_locations :
A dictionary of release locations for particles

Returns
-------
particleset
A parcels.ParticleSet object
"""

# Load release type information
release_type = settings['release']['initialisation_type'] # TODO: MAKE THIS PART BETTER!

release_quantity_names = {
'coastal': 'MPW_Cell',
'rivers': 'Emissions',
'fisheries': 'fishing_hours',
'global_concentrations': 'Concentration'
}
release_quantity_name = release_quantity_names[release_type]

particle_locations = pd.read_csv(settings['release_maps'][release_type])

# Select specific continent/region/subregion/country/economic status if applicable:
if 'continent' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Continent'] == settings['release']['continent']]
if 'region' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Region'] == settings['release']['region']]
if 'subregion' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Subregion'] == settings['release']['subregion']]
if 'country' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Country'] == settings['release']['country']]
if 'economicstatus' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Economic status'] == settings['release']['economicstatus']]
if 'concentration_type' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['ConcentrationType'] == settings['release']['concentration_type']]

particle_locations = particle_locations.groupby(['Longitude', 'Latitude'])[release_quantity_name].agg('sum').reset_index()
particle_locations = particle_locations[particle_locations[release_quantity_name] > 0]

release_locations = {'lons': particle_locations['Longitude'],
'lats': particle_locations['Latitude'],
'plastic_amount': particle_locations[release_quantity_name]}

# Set the longitude, latitude, and plastic amount per particle
lons = release_locations['lons']
lats = release_locations['lats']
plastic_amounts = release_locations['plastic_amount']
if 'plastic_amount' in release_locations.keys():
plastic_amounts = release_locations['plastic_amount']
else:
plastic_amounts = np.nan_like(lons)

# 20240429 - for simplification I have removed the option to set custom times and depths, as well as different densities, diameters, and wind_coefficients, this can be done in an alternate way
# TODO: Update this to use model grid id's instead of T-points lat/lon
# Set particle properties
plastic_densities = np.full(lons.shape, settings['plastictype']['plastic_density'])
plastic_diameters = np.full(lons.shape, settings['plastictype']['plastic_diameter'])
Expand Down Expand Up @@ -301,6 +270,61 @@ def create_particleset_from_map(fieldset, settings):
return pset


def create_particleset_from_map(fieldset, settings):
""" A constructor method to create a Parcels.ParticleSet for a plasticparcels simulation from one of the available initialisation maps

Parameters
----------
fieldset :
A Parcels.FieldSet object
settings :
A dictionary of model settings, simulation settings, and release settings and plastic-type settings

Returns
-------
particleset
A parcels.ParticleSet object
"""

# Load release type information
release_type = settings['release']['initialisation_type']

release_quantity_names = {
'coastal': 'MPW_Cell',
'rivers': 'Emissions',
'fisheries': 'fishing_hours',
'global_concentrations': 'Concentration'
}
release_quantity_name = release_quantity_names[release_type]

particle_locations = pd.read_csv(settings['release_maps'][release_type])

# Select specific continent/region/subregion/country/economic status if applicable:
if 'continent' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Continent'] == settings['release']['continent']]
if 'region' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Region'] == settings['release']['region']]
if 'subregion' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Subregion'] == settings['release']['subregion']]
if 'country' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Country'] == settings['release']['country']]
if 'economicstatus' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['Economic status'] == settings['release']['economicstatus']]
if 'concentration_type' in settings['release'].keys():
particle_locations = particle_locations[particle_locations['ConcentrationType'] == settings['release']['concentration_type']]

particle_locations = particle_locations.groupby(['Longitude', 'Latitude'])[release_quantity_name].agg('sum').reset_index()
particle_locations = particle_locations[particle_locations[release_quantity_name] > 0]

release_locations = {'lons': particle_locations['Longitude'],
'lats': particle_locations['Latitude'],
'plastic_amount': particle_locations[release_quantity_name]}

pset = create_particleset(fieldset, settings, release_locations)

return pset


def create_kernel(fieldset):
""" A constructor method to create a list of kernels for a plasticparcels simulation

Expand Down