Model:Sakura: Difference between revisions

From CSDMS
← Older edit
No edit summary
m Text replacement - "{{End headertab}}" to "{{End headertab}} {{{{PAGENAME}}_autokeywords}}"
 
(47 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Model identity
|Model type=Single
}}
{{Start models incorporated}}
{{End a table}}
{{Model identity2
|ModelDomain=Coastal, Marine
|One-line model description=3 Equation hyperpycnal flow model
|Extended model description=3-equation hyperpycnal flow model.
}}
{{Start model keyword table}}
{{Model keywords
|Model keywords=sediment transport
}}
{{End a table}}
{{Modeler information
{{Modeler information
|First name=Yusuke
|First name=Yusuke
Line 7: Line 22:
|Town / City=Yokohama
|Town / City=Yokohama
|Postal code=236-0001
|Postal code=236-0001
|State=NO STATE
|Country=Japan
|Country=Japan
|Email address=kuboy@jamstec.go.jp
|Email address=kuboy@jamstec.go.jp
Line 15: Line 29:
|Additional last name=Hutton
|Additional last name=Hutton
|Additional type of contact=Model developer
|Additional type of contact=Model developer
}}
|Additional country=United States
{{Model identity
|Model type=Single
|Categories=Coastal, Marine
|One-line model description=3 Equation hyperpycnal flow model
|Extended model description=3-equation hyperpycnal flow model.
}}
}}
{{Model technical information
{{Model technical information
Line 28: Line 37:
|Start year development=2002
|Start year development=2002
|Does model development still take place?=Yes
|Does model development still take place?=Yes
|Model availability=As code
|DevelopmentCode=As is, no updates are provided
|Source code availability=Through CSDMS repository
|DevelopmentCodeYearChecked=2020
|Source code availability=Through web repository
|Source web address=https://github.com/mcflugen/sedflux
|Program license type=Apache public license
|Program license type=Apache public license
|OpenMI compliant=No but possible
|CCA component=No but possible
|IRF interface=No but possible
|Memory requirements=Minimal
|Memory requirements=Minimal
|Typical run time=Seconds
|Typical run time=Seconds
Line 42: Line 50:
* Bathymetry
* Bathymetry
|Input format=ASCII
|Input format=ASCII
|Describe output parameters=CSV file of final bathymetry and deposit thickness for each grain size contained in the flow  
|Describe output parameters=CSV file of final bathymetry and deposit thickness for each grain size contained in the flow
|Output format=ASCII
|Output format=ASCII
|Pre-processing software needed?=No
|Pre-processing software needed?=No
Line 49: Line 57:
}}
}}
{{Process description model
{{Process description model
|Describe processes represented by the model=Hyperpycnal flow  
|Describe processes represented by the model=Hyperpycnal flow
|Describe key physical parameters and equations=See Kubo 2003 (doi:10.1016/j.sedgeo.2003.11.002)  
|Describe key physical parameters and equations=See Kubo 2003 (doi:10.1016/j.sedgeo.2003.11.002)
|Describe length scale and resolution constraints=Horizontal resolution is typically 10s of meters  
|Describe length scale and resolution constraints=Horizontal resolution is typically 10s of meters
|Describe time scale and resolution constraints=A single river flood event.  
|Describe time scale and resolution constraints=A single river flood event.
}}
{{Model testing
|Describe available calibration data sets=--
|Describe available test data sets=--
|Describe ideal data for testing=--
}}
}}
{{Model testing}}
{{Users groups model
{{Users groups model
|Do you have current or future plans for collaborating with other researchers?=None
|Do you have current or future plans for collaborating with other researchers?=None
}}
}}
{{Documentation model
{{Documentation model
|Provide key papers on model if any=doi:10.1016/j.sedgeo.2003.11.002
|Manual model available=No
|Manual model available=No
}}
}}
{{Additional comments model}}
{{Additional comments model}}
{{Infobox Model
{{CSDMS staff part
|model name              = Sakura
|OpenMI compliant=No but possible
|developer                = '''Kubo''', Yusuke
|IRF interface=No but possible
|one-line-description    = 3 Equation hyperpycnal flow model 
|CMT component=No but possible
|type                    = Model
|CCA component=No but possible
|source                  = <linkedimage>wikipage=Model:Sakura
tooltip=Download Sakura
img_src=Green1.png</linkedimage>
}}
}}
{{DOI information
|DOI model=10.1594/IEDA/100158
|DOI assigned to model version=2.1
|DOI-year assigned to model version=2011
|DOI-filelink=https://csdms.colorado.edu/pub/models/doi-source-code/sedflux-10.1594.IEDA.100161-2.1.tar.gz
}}
{{Start coupled table}}
{{End a table}}
{{End headertab}}
{{{{PAGENAME}}_autokeywords}}
<!-- Edit the part above to update info on other papers -->
<!-- Edit the part above to update info on other papers -->


== Sakura ==
__TOC__
===Introduction===
=== History ===
=== Papers ===
=== Sakura Questionnaire ===
==== Contact Information ====
{| class="wikitable"
| class="model_col1"| Model:
| class="model_col2"| Sakura
|-
| class="model_col1"| Contact person:
| class="model_col2"| Yusuke Kubo
|-
| class="model_col1"| Institute:
| class="model_col2"| --
|-
| class="model_col1"| City:
| class="model_col2"| --
|-
| class="model_col1"| Country:
| class="model_col2"| Japan
|-
| class="model_col1"| Email:
| class="model_col2"| --
|-
| class="model_col1"| 2nd person involved:
| class="model_col2"| Eric Hutton
|-
| class="model_col1"| 3rd person involved:
| class="model_col2"| --
|}
==== Model description ====
{| class="wikitable"
| class="model_col1"| Model type:
| class="model_col2"| Single model
|-
| class="model_col1"| Description:
| class="model_col2"| 3-equation hyperpycnal flow model.
|}
==== Technical information ====
{| class="wikitable"
| class="model_col1"| Supported platforms:
| class="model_col2"| UNIX, Linux, Mac OSX, Windows
|-
| class="model_col1"| Programming language:
| class="model_col2"|  C
|-
| class="model_col1"| Model was developed started from:
| class="model_col2"| 2002 and development still takes place
|-
| class="model_col1"| To what degree will the model become available:
| class="model_col2"| As code
|-
| class="model_col1"| Current license type:
| class="model_col2"| Apache public license
|-
| class="model_col1"| Memory requirements:
| class="model_col2"| Minimal
|-
| class="model_col1"| Typical run time:
| class="model_col2"| Seconds
|}
==== Input / Output description ====
{| class="wikitable"
| class="model_col1"| Input parameters:
| class="model_col2"| Main input parameters:
* River velocity, width, depth, and sediment concentration
* Bathymetry
|-
| class="model_col1"| Input format:
| class="model_col2"| ASCII
|-
| class="model_col1"| Output parameters:
| class="model_col2"| CSV file of final bathymetry and deposit thickness for each grain size contained in the flow   
|-
| class="model_col1"| Output format:
| class="model_col2"| ASCII
|-
| class="model_col1"| Post-processing software (if needed):
| class="model_col2"| no
|-
| class="model_col1"| Visualization software (if needed):
| class="model_col2"| no
|}
==== Process description ====
{| class="wikitable"
| class="model_col1"| Processes represented by model:
| class="model_col2"| Hyperpycnal flow
|-
| class="model_col1"| Key physical parameters & equations:
| class="model_col2"| See Kubo 2003 (doi:10.1016/j.sedgeo.2003.11.002)
|-
| class="model_col1"| Length scale & resolution constraints:
| class="model_col2"| Horizontal resolution is typically 10s of meters
|-
| class="model_col1"| Time scale & resolution constraints:
| class="model_col2"| A single river flood event.
|-
| class="model_col1"| Numerical limitations and issues :
| class="model_col2"|
|}
==== Testing ====
{| class="wikitable"
| class="model_col1"| Available calibration data sets:
| class="model_col2"|
|-
| class="model_col1"| Available test data sets:
| class="model_col2"| --
|-
| class="model_col1"| Ideal data for testing:
| class="model_col2"| --
|}
==== User groups ====
{| class="wikitable"
| class="model_col1"| Currently or plans for collaborating with:
| class="model_col2"| None
|}
==== Documentation ====
{| class="wikitable"
| class="model_col1"| Key papers of the model:
| class="model_col2"| doi:10.1016/j.sedgeo.2003.11.002
|-
| class="model_col1"| Is there a manual available:
| class="model_col2"| no
|-
| class="model_col1"| Model website if any:
| class="model_col2"| --
|}
==== Additional comments ====
{| class="wikitable"
| class="model_col1"| Comments:
| class="model_col2"| --
|}
=== Issues ===
=== Help ===
=== Input Files ===
=== Output Files ===
=== Download ===
{{Download Model|sakura}}
=== Source ===
''Sakura'' is part of the ''sedflux'' model.  Although it is also available as a seperate distribution, its source code is contained within the sedflux repository.
To browse the repository, point your browser to: [http://csdms.colorado.edu/viewvc/sedflux/?root=sedflux http://csdms.colorado.edu/viewvc/sedflux/?root=sedflux]
==== Command-Line Access ====
If you plan to make changes, use this command to check out the code as yourself using HTTPS:
<geshi lang=bash>
# Project members authenticate over HTTPS to allow committing changes.
svn checkout https://csdms.colorado.edu/svn/sedflux/
</geshi>


When prompted, enter your CSDMS Subversion password.


Non-members may only check out a read-only working copy of the project source.
==Introduction==


To obtain a CSDMS Subversion account or to become a member of this project, please email [mailto:csdms@colorado.edu csdms@colorado.edu].
== History ==


==== GUI and IDE Access ====
== References  ==
<br>{{AddReferenceUploadButtons}}<br><br>
{{#ifexist:Template:{{PAGENAME}}-citation-indices|{{{{PAGENAME}}-citation-indices}}|}}<br>
{{Include_featured_references_models_cargo}}<br>


This project's Subversion repository may be accessed using many different client programs and plug-ins. See your client's documentation for more information.
== Issues ==


==== Subversion Help ====
== Help ==
{{#ifexist:Model_help:{{PAGENAME}}|[[Model_help:{{PAGENAME}}]]|}}


For help on how to use Subversion, an excellent manual is available online at [http://svnbook.red-bean.com/ http://svnbook.red-bean.com/]
== Input Files ==


[[Category:Coastal]]
== Output Files ==
[[Category:Marine]]

Latest revision as of 20:17, 16 September 2020



Sakura


Metadata

Also known as
Model type Single
Model part of larger framework
Note on status model
Date note status model
Incorporated models or components:
Spatial dimensions
Spatial extent
Model domain Coastal, Marine
One-line model description 3 Equation hyperpycnal flow model
Extended model description 3-equation hyperpycnal flow model.
Keywords:

sediment transport,

Name Yusuke Kubo
Type of contact Model developer
Institute / Organization Center for Deep Earth Exploration (CDEX)
Postal address 1 3173-25 Showa-machi, Kanazawa-ku
Postal address 2
Town / City Yokohama
Postal code 236-0001
State
Country Japan
Email address kuboy@jamstec.go.jp
Phone
Fax


Name Eric Hutton
Type of contact Model developer
Institute / Organization
Postal address 1
Postal address 2
Town / City
Postal code
State
Country United States
Email address
Phone
Fax


Supported platforms
Unix, Linux, Mac OS, Windows
Other platform
Programming language

C

Other program language
Code optimized Single Processor
Multiple processors implemented
Nr of distributed processors
Nr of shared processors
Start year development 2002
Does model development still take place? Yes
If above answer is no, provide end year model development
Code development status As is, no updates are provided
When did you indicate the 'code development status'? 2020
Model availability
Source code availability
(Or provide future intension) 		Through web repository
Source web address https://github.com/mcflugen/sedflux
Source csdms web address
Program license type Apache public license
Program license type other
Memory requirements Minimal
Typical run time Seconds


Describe input parameters Main input parameters:
  • River velocity, width, depth, and sediment concentration
  • Bathymetry
Input format ASCII
Other input format
Describe output parameters CSV file of final bathymetry and deposit thickness for each grain size contained in the flow
Output format ASCII
Other output format
Pre-processing software needed? No
Describe pre-processing software
Post-processing software needed? No
Describe post-processing software
Visualization software needed? No
If above answer is yes
Other visualization software


Describe processes represented by the model Hyperpycnal flow
Describe key physical parameters and equations See Kubo 2003 (doi:10.1016/j.sedgeo.2003.11.002)
Describe length scale and resolution constraints Horizontal resolution is typically 10s of meters
Describe time scale and resolution constraints A single river flood event.
Describe any numerical limitations and issues


Describe available calibration data sets
Upload calibration data sets if available:
Describe available test data sets
Upload test data sets if available:
Describe ideal data for testing


Do you have current or future plans for collaborating with other researchers? None
Is there a manual available? No
Upload manual if available:
Model website if any
Model forum / discussion board
Comments


This part will be filled out by CSDMS staff

OpenMI compliant No but possible
BMI compliant No but possible
WMT component No but possible
PyMT component
Is this a data component
DOI model 10.1594/IEDA/100158
For model version 2.1
Year version submitted 2011
Link to file https://csdms.colorado.edu/pub/models/doi-source-code/sedflux-10.1594.IEDA.100161-2.1.tar.gz
Can be coupled with:
Model info
Authors
Yusuke Kubo
Hutton
Source code
DOI

Model citations
Nr. of publications: 2
Total citations: 63
h-index: 1
m-quotient: 0.05
QR-code

Link to this page
Other models by author



Introduction

History

References



Nr. of publications: 2
Total citations: 63
h-index: 1
m-quotient: 0.05



Featured publication(s)YearModel describedType of ReferenceCitations
Kubo, Yu'suke; 2004. Experimental and numerical study of topographic effects on deposition from two-dimensional, particle-driven density currents. Sedimentary Geology, 164, 311–326. 10.1016/j.sedgeo.2003.11.002
(View/edit entry)		2004 Sakura
 Model overview 63
Kubo, Y.; Hutton, E.W.H.; 2011. Sakura, version 2.1.. , , https://csdms.colorado.edu/pub/models/doi-source-code/sedflux-10.1594.IEDA.100161-2.1.tar.gz. 10.1594/IEDA/100158
(View/edit entry)		2011 Sakura
 Source code ref. 0
See more publications of Sakura


Issues

Help

Input Files

Output Files

Retrieved from "https://csdms.colorado.edu/csdms_wiki/index.php?title=Model:Sakura&oldid=299945"