Model:Sakura: Difference between revisions

From CSDMS
← Older editNewer edit →
No edit summary
m removed old questionnaire information. Replaced with form
Line 78: Line 78:
<!-- Edit the part above to update info on other papers -->
<!-- Edit the part above to update info on other papers -->


== Sakura ==
==Introduction==
__TOC__


===Introduction===
== History ==


=== History ===
== Papers ==


=== Papers ===
== Issues ==


=== Sakura Questionnaire ===
== Help ==


==== Contact Information ====
== Input Files ==


{| class="wikitable"
== Output Files ==
| 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 ====
== Download ==
 
{| 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}}
{{Download Model|sakura}}


Line 255: Line 104:
If you plan to make changes, use this command to check out the code as yourself using HTTPS:
If you plan to make changes, use this command to check out the code as yourself using HTTPS:


<geshi lang=bash>
<syntaxhighlight lang=bash>
# Project members authenticate over HTTPS to allow committing changes.
# Project members authenticate over HTTPS to allow committing changes.
svn checkout https://csdms.colorado.edu/svn/sedflux/
svn checkout https://csdms.colorado.edu/svn/sedflux/
</geshi>
</syntaxhighlight>


When prompted, enter your CSDMS Subversion password.
When prompted, enter your CSDMS Subversion password.
Line 266: Line 115:
To obtain a CSDMS Subversion account or to become a member of this project, please email [mailto:csdms@colorado.edu csdms@colorado.edu].
To obtain a CSDMS Subversion account or to become a member of this project, please email [mailto:csdms@colorado.edu csdms@colorado.edu].


==== GUI and IDE Access ====
=== GUI and IDE Access ===


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


==== Subversion Help ====
=== Subversion Help ===


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

Revision as of 09:59, 18 September 2009

Contact

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 NO 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
Email address
Phone
Fax



Sakura


Metadata

Summary

Also known as
Model type Single
Model part of larger framework
Note on status model
Date note status model

Technical specs

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
When did you indicate the 'code development status'?
Model availability As code
Source code availability
(Or provide future intension) 		Through CSDMS repository
Source web address
Source csdms web address
Program license type Apache public license
Program license type other
Memory requirements Minimal
Typical run time Seconds


In/Output

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


Process

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


Testing

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 --


Other

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


Introduction

History

Papers

Issues

Help

Input Files

Output Files

Download

Template:Download Model

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

Command-Line Access

If you plan to make changes, use this command to check out the code as yourself using HTTPS: 

# Project members authenticate over HTTPS to allow committing changes.
svn checkout https://csdms.colorado.edu/svn/sedflux/

When prompted, enter your CSDMS Subversion password.

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

To obtain a CSDMS Subversion account or to become a member of this project, please email csdms@colorado.edu.

GUI and IDE Access

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

Subversion Help

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

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