Data

Tools

Indexes

Applications

Experiments

Open Source Science

force-lx

Public version of ForCE-LX

https://github.com/maidavidson/force-lx

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (9.9%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Public version of ForCE-LX

Basic Info
  • Host: GitHub
  • Owner: maidavidson
  • Language: MATLAB
  • Default Branch: main
  • Size: 130 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created over 1 year ago · Last pushed 9 months ago
Metadata Files
Readme Citation

README.md

ForCE-LX

Public version of ForCE-LX

This folder contains the code for ForCE-LX.

This is one-line model for the shoreline displacement due to cross-shore/longshore sediment transport, sea level rise and sediment sources and sinks. The model is designed to accommodate complex coastlines including geological features and anthropogenic structures.

The code is provided in this instance to support a publication in review. Although the repository is publicly available without licence, the model is not yet ready for general use as it lacks the support guidance required to run the model on new sites effectively. The model runs provided only support the publication in review. As such the authors offer no support for this model/code and accept no liability for its application and use currently.
This said further support is planned for the future and this site will be updated accordingly when the paper is published, and the support material is ready.

The RunForce.m program initiates the model run. RunForce.m allows the user to open setup files that are located in any of the following locations:

Projects/Perrnporth/inputData/setupPerranporth_LX.m

Projects/Breakwaters/inputData/setupConstantWaveTest_LS.m

Projects/LogSpiralExample/inputData/SetupLXa10b2_0.m

Having loaded the setup file, which contains all the user input variables including the names of the data files used to initialise the model, RunForCE.m then runs the model code ForCE.m.
Note that the setup file can be opened and edited by the user to change the model parameters.

Output data files are then deposited in the outputData folders at the same directory level as the inputData directory.

Citation (citation.cff) 

cff-version: 1.0.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Mark"
  given-names: "Davidson"
  orcid: "https://orcid.org/0000-0001-9208-8297"
title: "ForCE-LX"
version: 1.0.0
doi: 10.5281/zenodo.15521162
date-released: 2025-05-26
url: "https://github.com/maidavidson/ForCE-LX/tree/v1.0.0ForCE-LX"

GitHub Events

Total
  • Push event: 5
Last Year
  • Push event: 5