HackMD
  • Beta
    Beta  Get a sneak peek of HackMD’s new design
    Turn on the feature preview and give us feedback.
    Go → Got it
      • Create new note
      • Create a note from template
    • Beta  Get a sneak peek of HackMD’s new design
      Beta  Get a sneak peek of HackMD’s new design
      Turn on the feature preview and give us feedback.
      Go → Got it
      • Sharing Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • More (Comment, Invitee)
      • Publishing
        Please check the box to agree to the Community Guidelines.
        Everyone on the web can find and read all notes of this public team.
        After the note is published, everyone on the web can find and read this note.
        See all published notes on profile page.
      • Commenting Enable
        Disabled Forbidden Owners Signed-in users Everyone
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Invitee
      • No invitee
      • Options
      • Versions and GitHub Sync
      • Transfer ownership
      • Delete this note
      • Template
      • Save as template
      • Insert from template
      • Export
      • Dropbox
      • Google Drive Export to Google Drive
      • Gist
      • Import
      • Dropbox
      • Google Drive Import from Google Drive
      • Gist
      • Clipboard
      • Download
      • Markdown
      • HTML
      • Raw HTML
    Menu Sharing Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Versions and GitHub Sync Transfer ownership Delete this note
    Export
    Dropbox Google Drive Export to Google Drive Gist
    Import
    Dropbox Google Drive Import from Google Drive Gist Clipboard
    Download
    Markdown HTML Raw HTML
    Back
    Sharing
    Sharing Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Note Permission
    Read
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Write
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    More (Comment, Invitee)
    Publishing
    Please check the box to agree to the Community Guidelines.
    Everyone on the web can find and read all notes of this public team.
    After the note is published, everyone on the web can find and read this note.
    See all published notes on profile page.
    More (Comment, Invitee)
    Commenting Enable
    Disabled Forbidden Owners Signed-in users Everyone
    Permission
    Owners
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Invitee
    No invitee
       owned this note    owned this note      
    Published Linked with GitHub
    Like BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    # OSCAR Meeting November: Thoughts and results ## Developer Guidelines for Julia code OSCAR developer guidelines (brief) #### Naming functions and variables variables: CamelCase functions: small_letters, words_separated_by ‘_’ #### Named arguments Use named arguments if: - many optional arguments - optional arguments might change in the future #### Documenting Code For details: https://docs.julialang.org/en/v1/manual/documentation/index.html - All user functions need to be documented in Julia’s markdown format: https://docs.julialang.org/en/latest/stdlib/Markdown/ - Example: @doc Markdown.doc""" parent(a::AbstractAlgebra.PolyElem) > Return the parent of the given polynomial. """ parent(a::PolynomialElem) = a.parent - Can also include: * example of usage * explanation of algorithms (including reference to literature) - To build documentation automatically on GitHub, see: https://github.com/JuliaDocs/Documenter.jl https://pages.github.com/ - Example https://github.com/Nemocas/Nemo.jl/blob/master/.travis.yml https://github.com/Nemocas/Nemo.jl/blob/master/docs/make.jl ### Food for thought: #### Advantages of GAP-doc 1. Cross referencing between modules 2. Possibility of documenting description, algorithms and interface of the function in different places. - cleaning up repositories in oscar-system on github ## Status of the Oscar components TODO (today, on the train) ### Polymake.jl - improvement of maintainability - binary builder allows us to use [Travis.ci](https://travis-ci.org/) - "list_properties" works now, not on master yet ## Next things to do for Oscar components - oscar-dev needs to be public, if used much reconsider the communication [notes](https://hackmd.io/_uIlbM8FSE6CjttGMoGm7w?both#Future-options-for-enhancing-communication) below, add information how to sign up on oscar page, make sure it works (email Hans) - Write more news articles ### Polymake.jl - Problem: polymake counts from 0, Julia from 1. - Solution: Stick to Julia convention, solve problem on level 1 and 0. - Properties that need to be converted will be tagged on level 0. ## Continuous integration (CI) Various formats of tests * Unit tests & Regression tests Short tests, can be run for every commit/PR * Integration tests Longer tests, for stability and compatibility of the whole ecosystem * Monitoring of performance: Monitor test times When should tests be run? * Short tests should be run on Travis * Integration tests should be run in fixed intervals, if anything has changed * Make Jenkins check for changes every hour * Only rebuild changed software * If something has changed, run tests * While tests run, do not check for updates Which versions of software should be used? * Fixed versions of Julia? Master? * New/fixed versions of Cornerstones Where/How should test failures reported? * Travis -> Github * Jenkins: Emails? Webpage board? GitHub post? * Idea: Post daily status to a mailing list * Notify all people from new commits per mail (only if test fails two times) * Add badge to Readme's How to filter test output to make the error message readable? * Try to get the error as precise as possible ## Handling large fans For tropical varieties, GIT fans, Groebner fans and secondary fans we are currently dealing with very large datasets, e.g. the secondary fan of the hypersimplex(2,7) contains >30'000'000 triangulations and to save it takes at least 1GB of memory (compressed). We have several datasets that are orders of magnitude larger. We do not want to recompute them, since this often takes several weeks/months, so the question is how we can provide them to everyone who needs them in a practical manner. - Save fans as collection of cones in [polyDB](https://polymake.org/doku.php/data) - Use property RAY_LABELS to identify combinatorial structure of fan - For [mptopcom](https://polymake.org/doku.php/mptopcom) it is necessary to output the rays of the secondary fan, which is currently not done ## Communication ### What we have #### [Link to mailing lists on the wiki](https://github.com/oscar-system/OSCAR-private/wiki/Mailing-Lists) [website](https://oscar.computeralgebra.de/), [blog](https://oscar.computeralgebra.de/blog/) [github](https://github.com/oscar-system) email slack ### Future options for enhancing communication Email: discussions with individuals/very private discussions Private: oscar-private (TRR organisation only, not public, no archive) Announcements: oscar (public subscription, archive) Public: Options - Discourse ($100 month/open source, maintained) - PhPBB(free/open source, we maintain) GitHub: issue tracking, wiki Website: starting points, blog Slack: informal discussion with whoever is online trr195-members: announcements to trr participants Other forum options: Flarum, MyBB, vBulletin, NodeBB, YaBB Other examples: sage-devel (Google Group) ODK GitHub issues (even for discussions) Pelles C (PhPBB) Julia Discourse/GitHub ## Plan for future (next few weeks), apparently also wishes ### General discussion - Make interfaces that are available public, even if we get negative feedback - Public webpage with preliminary results marked as "for internal use" - Make benchmarks public - Make central place where install instructions are stored - ### Yue Ren - initial ideals (most general) - Singular.jl / Polymake.jl ### Frank Luebeck - Work out what releases should be, managing expectations - People should not get the wrong impression - Maybe just release the subprojects - Maybe not call it "Oscar.jl" - Only advertise what we have ### Fredrik Johansson - Work on Nemo and Flint ### William Bruce Hat - Get interface Nemo-Singular to work again - Get Singular libraries to work - Improve code - Commutative algebra ### Sascha Timme - Needs documentation, to use polynomials and polynomial rings - OSCAR should interact nicely with existing stuff - HomotopyContinuation.jl should not end up with binary dependency ### Andreas Steenpass - Extend prototype of ideal - Implement Groebner walk with Yue - Update PrymGreen.jl package for use with Julia 1.0 and CxxWrap. Requires to get Nemo coefficients to work in Singular again. ### Lars Kastner - get_schedule should work - write tests - fix various bugs discovered in polymake - graded injective resolutions ### Sebastian Gutsche - Get Singular generic rings working again - General maintenance, cleanup after workshop ### Thomas Breuer - Deal with pull requests for Gap - Add algorithms for invariant theory - Once Singular works with number fields, many algorithms become available ### Reimer Behrends - Fix bug in Julia garbage collector - Continuous integration, use jenkins ### Michael Joswig - Work with Claus - Make notebook to show what we can already do

    Import from clipboard

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lost their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template is not available.


    Upgrade

    All
    • All
    • Team
    No template found.

    Create custom template


    Upgrade

    Delete template

    Do you really want to delete this template?

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Tutorials

    Book Mode Tutorial

    Slide Mode Tutorial

    YAML Metadata

    Contacts

    Facebook

    Twitter

    Feedback

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions

    Versions and GitHub Sync

    Sign in to link this note to GitHub Learn more
    This note is not linked with GitHub Learn more
     
    Add badge Pull Push GitHub Link Settings
    Upgrade now

    Version named by    

    More Less
    • Edit
    • Delete

    Note content is identical to the latest version.
    Compare with
      Choose a version
      No search result
      Version not found

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub

        Please sign in to GitHub and install the HackMD app on your GitHub repo. Learn more

         Sign in to GitHub

        HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Available push count

        Upgrade

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Upgrade

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully