Giter Club home page Giter Club logo

oceanparcels_website's Introduction

Repository for the OceanParcels.org website

This git repository holds the code for the oceanparcels website

Copyright and License

Content copyright the OceanParcels project, licensed under a CC-BY license.

Layout is based on the Modern Business theme, which is copyrighted 2013-2017 by Blackrock Digital LLC and released under the MIT license.

oceanparcels_website's People

Contributors

ckehl avatar daanreijnders avatar delandmeterp avatar erikvansebille avatar michaeldenes avatar pdnooteboom avatar pre-commit-ci[bot] avatar reint-fischer avatar samuelhklumpers avatar veckothegecko avatar willirath avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

oceanparcels_website's Issues

Website refactor (flask)

The site currently has data and content intertwined with each other in the HTML making the site a bit difficult to maintain/grow.

I propose to introduce flask with Frozen-Flask to provide tooling to make the site easier to oversee, maintain, and extend.

Main changes:

  • Convert index.html and utrechtteam.html to templates
    • abstract out the bulk of the data on papers, and team members into yaml files. During build, this data is populated into the templates
  • Other pages remain untouched
  • Markdown support (flask-markdown) which compiles md to HTML during build
    • Markdown files can be included directly in the website
    • Markdown can be written directly within the HTML files

Everything according to plan, building the site will create the exact same website files that currently exist. I'm already familiar with this tooling, so this PR shouldn't take me too long to implement.

Blocked by #73

[BUG] Broken linking of tutorial notebooks

Recreation

  • Go to tutorials section
  • Ctrl + click a tutorial
  • Notebook opens in new tab, and current tab relocates to a 404 (eg. https://oceanparcels.org/documentation_stuck)

Initial thoughts
Clicking a link such as:

<a class="tutorialLink" href="https://nbviewer.jupyter.org/github/OceanParcels/parcels/blob/master/parcels/examples/documentation_stuck_particles.ipynb" onclick="captureTutorialLink('documentation_stuck');">

uses the captureTutorialLink callback:

<script>
/**
* Function that records clicks on tutorial links
* The function takes the tutorial link as an argument and sends it to Google Analytics as an event
* These clicks can be seen under Behaviour -> Events
* The hit is sent when 'navigator.sendBeacon' is used in a compatible browser
*/
var captureTutorialLink = function(url) {
ga('send', 'event', 'tutorial', 'click', url, {
'transport': 'beacon',
'hitCallback': function(){document.location = url;}
});
}

I think the fix is just removing 'hitCallback': function(){document.location = url;}.


Happy to work on this in the coming week or two when I have time. Feel free to claim if someone else wants to patch this beforehand.

[AUTOMATED] URL Status Reporting

Summary

Status Count
πŸ” Total 927
βœ… Successful 735
⏳ Timeouts 2
πŸ”€ Redirected 0
πŸ‘» Excluded 189
❓ Unknown 0
🚫 Errors 1

Errors per input

Errors in index.html

Errors in waddendrifters.html

Errors in vegu21.html

traffic between notebooks not seen.

Recently we have added many links between tutorial notebooks and the documentation for a more natural guide on specific parcels topics. We also added Google Analytics event tags to the tutorial tiles on the homepage to see how often people visit the notebooks. These event tags do not cover all the other links however. This is not a major problem but something to be aware of.

parcels documentation new website

The old website had a 'parcels documentation' tab, sorted by topic and with links to fragments of the source code. It was not properly updating with the releases and was quite ugly, however it offered a nice quick access to the code and supported quick learning/familiarising for users that wanted to dig deeper then the tutorials (or prefer reading small parts of the code, without having to open the full source code in a project and search in there). Is this coming back in the new website?

Documentation for example datasets

Is there any documentation about the datasets in examples-data (which are in turn used throughout the parcels examples)? Perhaps it would be worth adding a file examples-data/README.md to add quick descriptions to these. This can be propagated through to users in parcels if we want as well just by linking to the README here on GitHub.

Motivation

parcels_tutorial.ipynb mentions

since we know that the files are in what’s called Parcels FieldSet format, we can call these files using the function FieldSet.from_parcels()

I feel like the following would be better

The "MovingEddies_data" dataset contains data that is in Parcels FieldSet format. We can ingest this data into parcels using FieldSet.from_parcels(). For more information on available datasets see link

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.