Category: Blog

  • camels_netcdf

    CAMELS dataset in NetCDF/Feather formats

    Motivation

    The CAMELS datasets are not provided in an ideal format and takes a bit of data processing to convert them to useful and convenient forms for geospatial analyses. So, I decided to use the beloved netcdf and feather formats to make the dataset more accessible while taking care of some small annoyances! The generated files are hosted on Hydroshare.

    Usage

    First make sure that h5netcdf, geopandas, xarray, and requests Python packages are installed, then load the files directly like so:

    import io
    
    import geopandas as gpd
    import requests
    import xarray as xr
    
    r = requests.get("https://www.hydroshare.org/resource/658c359b8c83494aac0f58145b1b04e6/data/contents/camels_attributes_v2.0.feather")
    attrs = gpd.read_feather(io.BytesIO(r.content))
    
    r = requests.get("https://www.hydroshare.org/resource/658c359b8c83494aac0f58145b1b04e6/data/contents/camels_attrs_v2_streamflow_v1p2.nc")
    qobs = xr.open_dataset(io.BytesIO(r.content), engine="h5netcdf")

    Methodology

    This repo contains the code that I used to generate the datasets. Three data sources are available from the CAMELS dataset:

    The camel_netcdf.py generates two files:

    • camels_attributes_v2.0.feather: Includes basin geometries and 60 basin-level attributes that are available in CAMELS.
    • camels_attrs_v2_streamflow_v1p2.nc: Includes observed flows for all 671 stations, as well as the 60 basin-level attributes. It has two dimensions (station_id and time) and 60 data variables.

    Additionally, the script takes care of some small annoyances:

    • Station names didn’t have a consistent format and there were some missing commas and extra periods! Now, the names have a consistent format (title) and there is comma before the states.
    • Station IDs and HUC 02 are strings with leading zeros if needed.

    You can recreate the generated files locally using mambaforge (or conda) like so:

    git clone https://github.com/cheginit/camels_netcdf
    cd camels_netcdf
    mamba env create -f environment.yml
    conda activate camels
    chmod +x ./camels_netcdf.py
    ./camels_netcdf.py

    Example Plots

    Snow fraction using camels_attributes_v2.0.feather: camels_snow_fraction

    The dataset camels_attrs_v2_streamflow_v1p2.nc: dataset

    Streamflow observations for USGS-01013500: qobs_01013500

    Contributions

    Contributions are welcome! Please feel free to open an issue/PR if you have any suggestions that can improve the database.

    Visit original content creator repository https://github.com/cheginit/camels_netcdf
  • stwo-brainfuck

    stwo-brainfuck

    stwo-brainfuck is a ZK-VM for the Brainfuck language1, based on Stwo2.

    CLI – Installation

    Here are the steps to get the Brainfuck ZK-VM up and running.

    You can either download the binaries from the
    releases, or build them
    from source.

    Build from Source

    1. Clone the repository
    git clone git@github.com:kkrt-labs/stwo-brainfuck.git
    1. Build the brainfuck_prover

    The brainfuck_prover has a feature flag which enables the CPU parallelization
    feature of Stwo.

    No feature flags:

    cargo build --package brainfuck_prover --release

    Parallel feature flag:

    cargo build --package brainfuck_prover --features parallel --release

    CLI – Usage

    The brainfuck_prover CLI has two subcommands:

    • prove, which generates a CSTARK proof from a given Brainfuck program file or
      code string.
    • verify, which verify a CSTARK proof from a given Brainfuck proof file.

    For more information, try brainfuck_prover --help,
    brainfuck_prover prove --help and brainfuck_prover verify --help.

    Example usage

    Consider this Brainfuck program which, given an ASCII character from Stdin,
    outputs the following two characters in the ASCII table:

    ++>,<[>+.<-]

    Prove

    To generate a proof of this program, you can provide the Brainfuck program as a
    string, with the --code argument, or store it in a file my_program.bf and
    provide the path to it with the --file argument.

    Here, the proof will be serialized to a JSON file my_program_proof.json. You
    can also print the proof to stdout with the --print flag.

    1. Proof from a Brainfuck program given in the command
    brainfuck_prover prove --code "++>,<[>+.<-]" --output my_program_proof.json

    Or if you built from source,

    ./target/release/brainfuck_prover prove --code "++>,<[>+.<-]" --output my_program_proof.json
    1. Proof from program file
    brainfuck_prover prove --file my_program.bf --output my_program_proof.json

    Or if you built from source,

    ./target/release/brainfuck_prover prove --file ./brainfuck_programs/hello_kakarot.bf --output hello_kakarot_proof.json

    Verify

    To verify a proof, the proof must be stored in a JSON file (--output flag from
    the prove subcommand).

    brainfuck_prover verify my_program_proof.json

    Or if you built from source and previously generated the proof of the
    hello_kakarot example:

    ./target/release/brainfuck_prover verify hello_kakarot_proof.json

    Visualizing the memory

    To visualize the memory of the Brainfuck VM, use the --memory flag of the
    brainfuck_prover, and reduce the RAM size to avoid printing too much memory
    cells to your terminal with the --ram-size flag.

    Let’s try it with a Brainfuck program that yields the 19th Fibonacci number.
    Note that it is a bit more resource intensive than the other example programs.

    ./target/release/brainfuck_prover prove --file ./brainfuck_programs/fib19.bf --output fib19_proof.json --memory --ram-size 5

    You should be able to see:

    [M31(0), M31(2584), M31(4181), M31(0), M31(0)]

    The third memory cell contains the desired output: Fibonacci(19) = 4181.

    Project Objectives

    • Capacity of generating and verifying a proof for arbitrary Brainfuck programs.
    • Understanding of using Stwo for building ZK-VMs
    • Understanding of modern AIR (RAP) design for (C)STARK-based systems.

    Design choices

    Brainfuck VM

    The Brainfuck language has a very loose specification, though, a
    general specification has
    been established as a minimal base. We try to follow these guidelines.

    • The memory cells take values in the Mersenne31 (M31) field: $[0..2^{31} – 1)$
    • Memory is fixed at 30,000 cells by default, but is configurable.
    • Memory wraps on overflow/underflow.
      • It can be used for memory value mv and memory pointer mp, but it will
        usually panic for mp as the memory size will be much smaller than
        $2^{31} – 1$.
    • Inputs are line-buffered (ends with the linefeed ASCII character 10).
    • CLI uses Stdin and Stdout for IO.
    • For library use, input can be simulated by any reader (e.g. Cursor) and
      output with any writer (e.g. a custom writer).

    Acknowledgements

    The constraints used here rely on work made by Alan Szepieniec3 and sibling
    article from Neptune Cash4. The Brainfuck compiler and interpreter have been
    adapted from rkdud0075

    Footnotes

    1. Brainfuck Language

    2. Stwo repository

    3. BrainSTARK – Alan Szepieniec

    4. BrainSTARK – Neptune Cash

    5. rkdud007 brainfuck-zkvm repo

    Visit original content creator repository
    https://github.com/kkrt-labs/stwo-brainfuck

  • Museum-mui

    Museum Site

    Netlify Status

    Motivation

    Artist and artifacts are more praised but less explored This project is an effort to preserve the art and craft o the history

    why?

    This project was actually build to learn React js and Material UI this is the first project of mine based on react js. This whole project to the last semi-colon belongs to me

    overview

    Frontend:

    • React js
    • Hover js
    • Swiper js
    • Material Ui
    • THREE js
    • cloudinary
    Frontend Folder structure

    📦src
    ┣ 📂components
    ┃ ┣ 📜AnnouncementBar.jsx
    ┃ ┣ 📜Artist.jsx
    ┃ ┣ 📜Backdrop.jsx
    ┃ ┣ 📜Banner.jsx
    ┃ ┣ 📜Card.jsx
    ┃ ┣ 📜CardComponent.jsx
    ┃ ┣ 📜CollectionHighlight.jsx
    ┃ ┣ 📜Details.jsx
    ┃ ┣ 📜Events.jsx
    ┃ ┣ 📜footer.jsx
    ┃ ┣ 📜Gallery.jsx
    ┃ ┣ 📜Genre.jsx
    ┃ ┣ 📜GenreItem.jsx
    ┃ ┣ 📜header.jsx
    ┃ ┣ 📜HeroSlide.jsx
    ┃ ┣ 📜Highlights.jsx
    ┃ ┣ 📜History.jsx
    ┃ ┣ 📜loading.jsx
    ┃ ┣ 📜Medium.jsx
    ┃ ┣ 📜MediumItem.jsx
    ┃ ┣ 📜MockUp.jsx
    ┃ ┣ 📜MoreArtifacts.jsx
    ┃ ┣ 📜Podcast.jsx
    ┃ ┣ 📜Search.jsx
    ┃ ┣ 📜SearchedItem.jsx
    ┃ ┗ 📜VIdeo.jsx
    ┣ 📂Context
    ┃ ┗ 📜AuthContext.js
    ┣ 📂Pages
    ┃ ┣ 📜Artifact.jsx
    ┃ ┣ 📜Artists.jsx
    ┃ ┣ 📜Artwork.jsx
    ┃ ┣ 📜Collections.jsx
    ┃ ┣ 📜Home.jsx
    ┃ ┣ 📜Login.jsx
    ┃ ┣ 📜Medium.jsx
    ┃ ┣ 📜Profile.jsx
    ┃ ┗ 📜Register.jsx
    ┣ 📂utils
    ┃ ┣ 📜fetchArtistBanner.js
    ┃ ┣ 📜ProtectedRoute.js
    ┃ ┗ 📜server.js
    ┣ 📜App.css
    ┣ 📜App.js
    ┣ 📜index.js

    Frontend Routes ( with Images )

    / Home Route


    /profile User Profile Route

    /artists Major artists route

    /artist/:id Individual artist route

    /explore Route to display explorable artifacts /explore/:id individual explore page /artifact/:id individual artifact and details

    Other component

    Loading Screen display

    Login and Sign up

    Backend

    folder structure

    📦server
    ┣ 📂controller
    ┃ ┗ 📜authController.js
    ┣ 📂middleware
    ┃ ┣ 📜authMiddleware.js
    ┃ ┗ 📜uploadMiddleWare.js
    ┣ 📂models
    ┃ ┗ 📜User.js
    ┣ 📂routes
    ┃ ┗ 📜authRoutes.js
    ┣ 📂utils
    ┃ ┗ 📜db.js
    ┗ 📜server.js

    hosting platform

    • Heroku ( backend )
    • Netlify (Frontend)

    Contribution?

    Available Scripts

    In the project directory, you can run:

    npm start

    Runs the app in the development mode.\

    Open http://localhost:3000 to view it in the browser.

    The page will reload if you make edits.\

    You will also see any lint errors in the console.

    npm test

    Launches the test runner in the interactive watch mode.\

    See the section about running tests for more information.

    npm run build

    Visit original content creator repository https://github.com/shikhar13012001/Museum-mui
  • MiniPacket

                        GNU GENERAL PUBLIC LICENSE
                           Version 3, 29 June 2007
    
     Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
     Everyone is permitted to copy and distribute verbatim copies
     of this license document, but changing it is not allowed.
    
                                Preamble
    
      The GNU General Public License is a free, copyleft license for
    software and other kinds of works.
    
      The licenses for most software and other practical works are designed
    to take away your freedom to share and change the works.  By contrast,
    the GNU General Public License is intended to guarantee your freedom to
    share and change all versions of a program--to make sure it remains free
    software for all its users.  We, the Free Software Foundation, use the
    GNU General Public License for most of our software; it applies also to
    any other work released this way by its authors.  You can apply it to
    your programs, too.
    
      When we speak of free software, we are referring to freedom, not
    price.  Our General Public Licenses are designed to make sure that you
    have the freedom to distribute copies of free software (and charge for
    them if you wish), that you receive source code or can get it if you
    want it, that you can change the software or use pieces of it in new
    free programs, and that you know you can do these things.
    
      To protect your rights, we need to prevent others from denying you
    these rights or asking you to surrender the rights.  Therefore, you have
    certain responsibilities if you distribute copies of the software, or if
    you modify it: responsibilities to respect the freedom of others.
    
      For example, if you distribute copies of such a program, whether
    gratis or for a fee, you must pass on to the recipients the same
    freedoms that you received.  You must make sure that they, too, receive
    or can get the source code.  And you must show them these terms so they
    know their rights.
    
      Developers that use the GNU GPL protect your rights with two steps:
    (1) assert copyright on the software, and (2) offer you this License
    giving you legal permission to copy, distribute and/or modify it.
    
      For the developers' and authors' protection, the GPL clearly explains
    that there is no warranty for this free software.  For both users' and
    authors' sake, the GPL requires that modified versions be marked as
    changed, so that their problems will not be attributed erroneously to
    authors of previous versions.
    
      Some devices are designed to deny users access to install or run
    modified versions of the software inside them, although the manufacturer
    can do so.  This is fundamentally incompatible with the aim of
    protecting users' freedom to change the software.  The systematic
    pattern of such abuse occurs in the area of products for individuals to
    use, which is precisely where it is most unacceptable.  Therefore, we
    have designed this version of the GPL to prohibit the practice for those
    products.  If such problems arise substantially in other domains, we
    stand ready to extend this provision to those domains in future versions
    of the GPL, as needed to protect the freedom of users.
    
      Finally, every program is threatened constantly by software patents.
    States should not allow patents to restrict development and use of
    software on general-purpose computers, but in those that do, we wish to
    avoid the special danger that patents applied to a free program could
    make it effectively proprietary.  To prevent this, the GPL assures that
    patents cannot be used to render the program non-free.
    
      The precise terms and conditions for copying, distribution and
    modification follow.
    
                           TERMS AND CONDITIONS
    
      0. Definitions.
    
      "This License" refers to version 3 of the GNU General Public License.
    
      "Copyright" also means copyright-like laws that apply to other kinds of
    works, such as semiconductor masks.
    
      "The Program" refers to any copyrightable work licensed under this
    License.  Each licensee is addressed as "you".  "Licensees" and
    "recipients" may be individuals or organizations.
    
      To "modify" a work means to copy from or adapt all or part of the work
    in a fashion requiring copyright permission, other than the making of an
    exact copy.  The resulting work is called a "modified version" of the
    earlier work or a work "based on" the earlier work.
    
      A "covered work" means either the unmodified Program or a work based
    on the Program.
    
      To "propagate" a work means to do anything with it that, without
    permission, would make you directly or secondarily liable for
    infringement under applicable copyright law, except executing it on a
    computer or modifying a private copy.  Propagation includes copying,
    distribution (with or without modification), making available to the
    public, and in some countries other activities as well.
    
      To "convey" a work means any kind of propagation that enables other
    parties to make or receive copies.  Mere interaction with a user through
    a computer network, with no transfer of a copy, is not conveying.
    
      An interactive user interface displays "Appropriate Legal Notices"
    to the extent that it includes a convenient and prominently visible
    feature that (1) displays an appropriate copyright notice, and (2)
    tells the user that there is no warranty for the work (except to the
    extent that warranties are provided), that licensees may convey the
    work under this License, and how to view a copy of this License.  If
    the interface presents a list of user commands or options, such as a
    menu, a prominent item in the list meets this criterion.
    
      1. Source Code.
    
      The "source code" for a work means the preferred form of the work
    for making modifications to it.  "Object code" means any non-source
    form of a work.
    
      A "Standard Interface" means an interface that either is an official
    standard defined by a recognized standards body, or, in the case of
    interfaces specified for a particular programming language, one that
    is widely used among developers working in that language.
    
      The "System Libraries" of an executable work include anything, other
    than the work as a whole, that (a) is included in the normal form of
    packaging a Major Component, but which is not part of that Major
    Component, and (b) serves only to enable use of the work with that
    Major Component, or to implement a Standard Interface for which an
    implementation is available to the public in source code form.  A
    "Major Component", in this context, means a major essential component
    (kernel, window system, and so on) of the specific operating system
    (if any) on which the executable work runs, or a compiler used to
    produce the work, or an object code interpreter used to run it.
    
      The "Corresponding Source" for a work in object code form means all
    the source code needed to generate, install, and (for an executable
    work) run the object code and to modify the work, including scripts to
    control those activities.  However, it does not include the work's
    System Libraries, or general-purpose tools or generally available free
    programs which are used unmodified in performing those activities but
    which are not part of the work.  For example, Corresponding Source
    includes interface definition files associated with source files for
    the work, and the source code for shared libraries and dynamically
    linked subprograms that the work is specifically designed to require,
    such as by intimate data communication or control flow between those
    subprograms and other parts of the work.
    
      The Corresponding Source need not include anything that users
    can regenerate automatically from other parts of the Corresponding
    Source.
    
      The Corresponding Source for a work in source code form is that
    same work.
    
      2. Basic Permissions.
    
      All rights granted under this License are granted for the term of
    copyright on the Program, and are irrevocable provided the stated
    conditions are met.  This License explicitly affirms your unlimited
    permission to run the unmodified Program.  The output from running a
    covered work is covered by this License only if the output, given its
    content, constitutes a covered work.  This License acknowledges your
    rights of fair use or other equivalent, as provided by copyright law.
    
      You may make, run and propagate covered works that you do not
    convey, without conditions so long as your license otherwise remains
    in force.  You may convey covered works to others for the sole purpose
    of having them make modifications exclusively for you, or provide you
    with facilities for running those works, provided that you comply with
    the terms of this License in conveying all material for which you do
    not control copyright.  Those thus making or running the covered works
    for you must do so exclusively on your behalf, under your direction
    and control, on terms that prohibit them from making any copies of
    your copyrighted material outside their relationship with you.
    
      Conveying under any other circumstances is permitted solely under
    the conditions stated below.  Sublicensing is not allowed; section 10
    makes it unnecessary.
    
      3. Protecting Users' Legal Rights From Anti-Circumvention Law.
    
      No covered work shall be deemed part of an effective technological
    measure under any applicable law fulfilling obligations under article
    11 of the WIPO copyright treaty adopted on 20 December 1996, or
    similar laws prohibiting or restricting circumvention of such
    measures.
    
      When you convey a covered work, you waive any legal power to forbid
    circumvention of technological measures to the extent such circumvention
    is effected by exercising rights under this License with respect to
    the covered work, and you disclaim any intention to limit operation or
    modification of the work as a means of enforcing, against the work's
    users, your or third parties' legal rights to forbid circumvention of
    technological measures.
    
      4. Conveying Verbatim Copies.
    
      You may convey verbatim copies of the Program's source code as you
    receive it, in any medium, provided that you conspicuously and
    appropriately publish on each copy an appropriate copyright notice;
    keep intact all notices stating that this License and any
    non-permissive terms added in accord with section 7 apply to the code;
    keep intact all notices of the absence of any warranty; and give all
    recipients a copy of this License along with the Program.
    
      You may charge any price or no price for each copy that you convey,
    and you may offer support or warranty protection for a fee.
    
      5. Conveying Modified Source Versions.
    
      You may convey a work based on the Program, or the modifications to
    produce it from the Program, in the form of source code under the
    terms of section 4, provided that you also meet all of these conditions:
    
        a) The work must carry prominent notices stating that you modified
        it, and giving a relevant date.
    
        b) The work must carry prominent notices stating that it is
        released under this License and any conditions added under section
        7.  This requirement modifies the requirement in section 4 to
        "keep intact all notices".
    
        c) You must license the entire work, as a whole, under this
        License to anyone who comes into possession of a copy.  This
        License will therefore apply, along with any applicable section 7
        additional terms, to the whole of the work, and all its parts,
        regardless of how they are packaged.  This License gives no
        permission to license the work in any other way, but it does not
        invalidate such permission if you have separately received it.
    
        d) If the work has interactive user interfaces, each must display
        Appropriate Legal Notices; however, if the Program has interactive
        interfaces that do not display Appropriate Legal Notices, your
        work need not make them do so.
    
      A compilation of a covered work with other separate and independent
    works, which are not by their nature extensions of the covered work,
    and which are not combined with it such as to form a larger program,
    in or on a volume of a storage or distribution medium, is called an
    "aggregate" if the compilation and its resulting copyright are not
    used to limit the access or legal rights of the compilation's users
    beyond what the individual works permit.  Inclusion of a covered work
    in an aggregate does not cause this License to apply to the other
    parts of the aggregate.
    
      6. Conveying Non-Source Forms.
    
      You may convey a covered work in object code form under the terms
    of sections 4 and 5, provided that you also convey the
    machine-readable Corresponding Source under the terms of this License,
    in one of these ways:
    
        a) Convey the object code in, or embodied in, a physical product
        (including a physical distribution medium), accompanied by the
        Corresponding Source fixed on a durable physical medium
        customarily used for software interchange.
    
        b) Convey the object code in, or embodied in, a physical product
        (including a physical distribution medium), accompanied by a
        written offer, valid for at least three years and valid for as
        long as you offer spare parts or customer support for that product
        model, to give anyone who possesses the object code either (1) a
        copy of the Corresponding Source for all the software in the
        product that is covered by this License, on a durable physical
        medium customarily used for software interchange, for a price no
        more than your reasonable cost of physically performing this
        conveying of source, or (2) access to copy the
        Corresponding Source from a network server at no charge.
    
        c) Convey individual copies of the object code with a copy of the
        written offer to provide the Corresponding Source.  This
        alternative is allowed only occasionally and noncommercially, and
        only if you received the object code with such an offer, in accord
        with subsection 6b.
    
        d) Convey the object code by offering access from a designated
        place (gratis or for a charge), and offer equivalent access to the
        Corresponding Source in the same way through the same place at no
        further charge.  You need not require recipients to copy the
        Corresponding Source along with the object code.  If the place to
        copy the object code is a network server, the Corresponding Source
        may be on a different server (operated by you or a third party)
        that supports equivalent copying facilities, provided you maintain
        clear directions next to the object code saying where to find the
        Corresponding Source.  Regardless of what server hosts the
        Corresponding Source, you remain obligated to ensure that it is
        available for as long as needed to satisfy these requirements.
    
        e) Convey the object code using peer-to-peer transmission, provided
        you inform other peers where the object code and Corresponding
        Source of the work are being offered to the general public at no
        charge under subsection 6d.
    
      A separable portion of the object code, whose source code is excluded
    from the Corresponding Source as a System Library, need not be
    included in conveying the object code work.
    
      A "User Product" is either (1) a "consumer product", which means any
    tangible personal property which is normally used for personal, family,
    or household purposes, or (2) anything designed or sold for incorporation
    into a dwelling.  In determining whether a product is a consumer product,
    doubtful cases shall be resolved in favor of coverage.  For a particular
    product received by a particular user, "normally used" refers to a
    typical or common use of that class of product, regardless of the status
    of the particular user or of the way in which the particular user
    actually uses, or expects or is expected to use, the product.  A product
    is a consumer product regardless of whether the product has substantial
    commercial, industrial or non-consumer uses, unless such uses represent
    the only significant mode of use of the product.
    
      "Installation Information" for a User Product means any methods,
    procedures, authorization keys, or other information required to install
    and execute modified versions of a covered work in that User Product from
    a modified version of its Corresponding Source.  The information must
    suffice to ensure that the continued functioning of the modified object
    code is in no case prevented or interfered with solely because
    modification has been made.
    
      If you convey an object code work under this section in, or with, or
    specifically for use in, a User Product, and the conveying occurs as
    part of a transaction in which the right of possession and use of the
    User Product is transferred to the recipient in perpetuity or for a
    fixed term (regardless of how the transaction is characterized), the
    Corresponding Source conveyed under this section must be accompanied
    by the Installation Information.  But this requirement does not apply
    if neither you nor any third party retains the ability to install
    modified object code on the User Product (for example, the work has
    been installed in ROM).
    
      The requirement to provide Installation Information does not include a
    requirement to continue to provide support service, warranty, or updates
    for a work that has been modified or installed by the recipient, or for
    the User Product in which it has been modified or installed.  Access to a
    network may be denied when the modification itself materially and
    adversely affects the operation of the network or violates the rules and
    protocols for communication across the network.
    
      Corresponding Source conveyed, and Installation Information provided,
    in accord with this section must be in a format that is publicly
    documented (and with an implementation available to the public in
    source code form), and must require no special password or key for
    unpacking, reading or copying.
    
      7. Additional Terms.
    
      "Additional permissions" are terms that supplement the terms of this
    License by making exceptions from one or more of its conditions.
    Additional permissions that are applicable to the entire Program shall
    be treated as though they were included in this License, to the extent
    that they are valid under applicable law.  If additional permissions
    apply only to part of the Program, that part may be used separately
    under those permissions, but the entire Program remains governed by
    this License without regard to the additional permissions.
    
      When you convey a copy of a covered work, you may at your option
    remove any additional permissions from that copy, or from any part of
    it.  (Additional permissions may be written to require their own
    removal in certain cases when you modify the work.)  You may place
    additional permissions on material, added by you to a covered work,
    for which you have or can give appropriate copyright permission.
    
      Notwithstanding any other provision of this License, for material you
    add to a covered work, you may (if authorized by the copyright holders of
    that material) supplement the terms of this License with terms:
    
        a) Disclaiming warranty or limiting liability differently from the
        terms of sections 15 and 16 of this License; or
    
        b) Requiring preservation of specified reasonable legal notices or
        author attributions in that material or in the Appropriate Legal
        Notices displayed by works containing it; or
    
        c) Prohibiting misrepresentation of the origin of that material, or
        requiring that modified versions of such material be marked in
        reasonable ways as different from the original version; or
    
        d) Limiting the use for publicity purposes of names of licensors or
        authors of the material; or
    
        e) Declining to grant rights under trademark law for use of some
        trade names, trademarks, or service marks; or
    
        f) Requiring indemnification of licensors and authors of that
        material by anyone who conveys the material (or modified versions of
        it) with contractual assumptions of liability to the recipient, for
        any liability that these contractual assumptions directly impose on
        those licensors and authors.
    
      All other non-permissive additional terms are considered "further
    restrictions" within the meaning of section 10.  If the Program as you
    received it, or any part of it, contains a notice stating that it is
    governed by this License along with a term that is a further
    restriction, you may remove that term.  If a license document contains
    a further restriction but permits relicensing or conveying under this
    License, you may add to a covered work material governed by the terms
    of that license document, provided that the further restriction does
    not survive such relicensing or conveying.
    
      If you add terms to a covered work in accord with this section, you
    must place, in the relevant source files, a statement of the
    additional terms that apply to those files, or a notice indicating
    where to find the applicable terms.
    
      Additional terms, permissive or non-permissive, may be stated in the
    form of a separately written license, or stated as exceptions;
    the above requirements apply either way.
    
      8. Termination.
    
      You may not propagate or modify a covered work except as expressly
    provided under this License.  Any attempt otherwise to propagate or
    modify it is void, and will automatically terminate your rights under
    this License (including any patent licenses granted under the third
    paragraph of section 11).
    
      However, if you cease all violation of this License, then your
    license from a particular copyright holder is reinstated (a)
    provisionally, unless and until the copyright holder explicitly and
    finally terminates your license, and (b) permanently, if the copyright
    holder fails to notify you of the violation by some reasonable means
    prior to 60 days after the cessation.
    
      Moreover, your license from a particular copyright holder is
    reinstated permanently if the copyright holder notifies you of the
    violation by some reasonable means, this is the first time you have
    received notice of violation of this License (for any work) from that
    copyright holder, and you cure the violation prior to 30 days after
    your receipt of the notice.
    
      Termination of your rights under this section does not terminate the
    licenses of parties who have received copies or rights from you under
    this License.  If your rights have been terminated and not permanently
    reinstated, you do not qualify to receive new licenses for the same
    material under section 10.
    
      9. Acceptance Not Required for Having Copies.
    
      You are not required to accept this License in order to receive or
    run a copy of the Program.  Ancillary propagation of a covered work
    occurring solely as a consequence of using peer-to-peer transmission
    to receive a copy likewise does not require acceptance.  However,
    nothing other than this License grants you permission to propagate or
    modify any covered work.  These actions infringe copyright if you do
    not accept this License.  Therefore, by modifying or propagating a
    covered work, you indicate your acceptance of this License to do so.
    
      10. Automatic Licensing of Downstream Recipients.
    
      Each time you convey a covered work, the recipient automatically
    receives a license from the original licensors, to run, modify and
    propagate that work, subject to this License.  You are not responsible
    for enforcing compliance by third parties with this License.
    
      An "entity transaction" is a transaction transferring control of an
    organization, or substantially all assets of one, or subdividing an
    organization, or merging organizations.  If propagation of a covered
    work results from an entity transaction, each party to that
    transaction who receives a copy of the work also receives whatever
    licenses to the work the party's predecessor in interest had or could
    give under the previous paragraph, plus a right to possession of the
    Corresponding Source of the work from the predecessor in interest, if
    the predecessor has it or can get it with reasonable efforts.
    
      You may not impose any further restrictions on the exercise of the
    rights granted or affirmed under this License.  For example, you may
    not impose a license fee, royalty, or other charge for exercise of
    rights granted under this License, and you may not initiate litigation
    (including a cross-claim or counterclaim in a lawsuit) alleging that
    any patent claim is infringed by making, using, selling, offering for
    sale, or importing the Program or any portion of it.
    
      11. Patents.
    
      A "contributor" is a copyright holder who authorizes use under this
    License of the Program or a work on which the Program is based.  The
    work thus licensed is called the contributor's "contributor version".
    
      A contributor's "essential patent claims" are all patent claims
    owned or controlled by the contributor, whether already acquired or
    hereafter acquired, that would be infringed by some manner, permitted
    by this License, of making, using, or selling its contributor version,
    but do not include claims that would be infringed only as a
    consequence of further modification of the contributor version.  For
    purposes of this definition, "control" includes the right to grant
    patent sublicenses in a manner consistent with the requirements of
    this License.
    
      Each contributor grants you a non-exclusive, worldwide, royalty-free
    patent license under the contributor's essential patent claims, to
    make, use, sell, offer for sale, import and otherwise run, modify and
    propagate the contents of its contributor version.
    
      In the following three paragraphs, a "patent license" is any express
    agreement or commitment, however denominated, not to enforce a patent
    (such as an express permission to practice a patent or covenant not to
    sue for patent infringement).  To "grant" such a patent license to a
    party means to make such an agreement or commitment not to enforce a
    patent against the party.
    
      If you convey a covered work, knowingly relying on a patent license,
    and the Corresponding Source of the work is not available for anyone
    to copy, free of charge and under the terms of this License, through a
    publicly available network server or other readily accessible means,
    then you must either (1) cause the Corresponding Source to be so
    available, or (2) arrange to deprive yourself of the benefit of the
    patent license for this particular work, or (3) arrange, in a manner
    consistent with the requirements of this License, to extend the patent
    license to downstream recipients.  "Knowingly relying" means you have
    actual knowledge that, but for the patent license, your conveying the
    covered work in a country, or your recipient's use of the covered work
    in a country, would infringe one or more identifiable patents in that
    country that you have reason to believe are valid.
    
      If, pursuant to or in connection with a single transaction or
    arrangement, you convey, or propagate by procuring conveyance of, a
    covered work, and grant a patent license to some of the parties
    receiving the covered work authorizing them to use, propagate, modify
    or convey a specific copy of the covered work, then the patent license
    you grant is automatically extended to all recipients of the covered
    work and works based on it.
    
      A patent license is "discriminatory" if it does not include within
    the scope of its coverage, prohibits the exercise of, or is
    conditioned on the non-exercise of one or more of the rights that are
    specifically granted under this License.  You may not convey a covered
    work if you are a party to an arrangement with a third party that is
    in the business of distributing software, under which you make payment
    to the third party based on the extent of your activity of conveying
    the work, and under which the third party grants, to any of the
    parties who would receive the covered work from you, a discriminatory
    patent license (a) in connection with copies of the covered work
    conveyed by you (or copies made from those copies), or (b) primarily
    for and in connection with specific products or compilations that
    contain the covered work, unless you entered into that arrangement,
    or that patent license was granted, prior to 28 March 2007.
    
      Nothing in this License shall be construed as excluding or limiting
    any implied license or other defenses to infringement that may
    otherwise be available to you under applicable patent law.
    
      12. No Surrender of Others' Freedom.
    
      If conditions are imposed on you (whether by court order, agreement or
    otherwise) that contradict the conditions of this License, they do not
    excuse you from the conditions of this License.  If you cannot convey a
    covered work so as to satisfy simultaneously your obligations under this
    License and any other pertinent obligations, then as a consequence you may
    not convey it at all.  For example, if you agree to terms that obligate you
    to collect a royalty for further conveying from those to whom you convey
    the Program, the only way you could satisfy both those terms and this
    License would be to refrain entirely from conveying the Program.
    
      13. Use with the GNU Affero General Public License.
    
      Notwithstanding any other provision of this License, you have
    permission to link or combine any covered work with a work licensed
    under version 3 of the GNU Affero General Public License into a single
    combined work, and to convey the resulting work.  The terms of this
    License will continue to apply to the part which is the covered work,
    but the special requirements of the GNU Affero General Public License,
    section 13, concerning interaction through a network will apply to the
    combination as such.
    
      14. Revised Versions of this License.
    
      The Free Software Foundation may publish revised and/or new versions of
    the GNU General Public License from time to time.  Such new versions will
    be similar in spirit to the present version, but may differ in detail to
    address new problems or concerns.
    
      Each version is given a distinguishing version number.  If the
    Program specifies that a certain numbered version of the GNU General
    Public License "or any later version" applies to it, you have the
    option of following the terms and conditions either of that numbered
    version or of any later version published by the Free Software
    Foundation.  If the Program does not specify a version number of the
    GNU General Public License, you may choose any version ever published
    by the Free Software Foundation.
    
      If the Program specifies that a proxy can decide which future
    versions of the GNU General Public License can be used, that proxy's
    public statement of acceptance of a version permanently authorizes you
    to choose that version for the Program.
    
      Later license versions may give you additional or different
    permissions.  However, no additional obligations are imposed on any
    author or copyright holder as a result of your choosing to follow a
    later version.
    
      15. Disclaimer of Warranty.
    
      THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
    APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
    HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
    OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
    THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
    PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
    IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
    ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
    
      16. Limitation of Liability.
    
      IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
    WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
    THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
    GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
    USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
    DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
    PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
    EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
    SUCH DAMAGES.
    
      17. Interpretation of Sections 15 and 16.
    
      If the disclaimer of warranty and limitation of liability provided
    above cannot be given local legal effect according to their terms,
    reviewing courts shall apply local law that most closely approximates
    an absolute waiver of all civil liability in connection with the
    Program, unless a warranty or assumption of liability accompanies a
    copy of the Program in return for a fee.
    
                         END OF TERMS AND CONDITIONS
    
                How to Apply These Terms to Your New Programs
    
      If you develop a new program, and you want it to be of the greatest
    possible use to the public, the best way to achieve this is to make it
    free software which everyone can redistribute and change under these terms.
    
      To do so, attach the following notices to the program.  It is safest
    to attach them to the start of each source file to most effectively
    state the exclusion of warranty; and each file should have at least
    the "copyright" line and a pointer to where the full notice is found.
    
        <one line to give the program's name and a brief idea of what it does.>
        Copyright (C) <year>  <name of author>
    
        This program is free software: you can redistribute it and/or modify
        it under the terms of the GNU General Public License as published by
        the Free Software Foundation, either version 3 of the License, or
        (at your option) any later version.
    
        This program is distributed in the hope that it will be useful,
        but WITHOUT ANY WARRANTY; without even the implied warranty of
        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
        GNU General Public License for more details.
    
        You should have received a copy of the GNU General Public License
        along with this program.  If not, see <https://www.gnu.org/licenses/>.
    
    Also add information on how to contact you by electronic and paper mail.
    
      If the program does terminal interaction, make it output a short
    notice like this when it starts in an interactive mode:
    
        <program>  Copyright (C) <year>  <name of author>
        This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
        This is free software, and you are welcome to redistribute it
        under certain conditions; type `show c' for details.
    
    The hypothetical commands `show w' and `show c' should show the appropriate
    parts of the General Public License.  Of course, your program's commands
    might be different; for a GUI interface, you would use an "about box".
    
      You should also get your employer (if you work as a programmer) or school,
    if any, to sign a "copyright disclaimer" for the program, if necessary.
    For more information on this, and how to apply and follow the GNU GPL, see
    <https://www.gnu.org/licenses/>.
    
      The GNU General Public License does not permit incorporating your program
    into proprietary programs.  If your program is a subroutine library, you
    may consider it more useful to permit linking proprietary applications with
    the library.  If this is what you want to do, use the GNU Lesser General
    Public License instead of this License.  But first, please read
    <https://www.gnu.org/licenses/why-not-lgpl.html>.
    

    Visit original content creator repository
    https://github.com/Beach-Launch-Team-CSULB/MiniPacket

  • gff-js

    @gmod/gff

    Build Status

    Read and write GFF3 data performantly. This module aims to be a complete implementation of the GFF3 specification.

    NOTE: this module uses the NPM stream package, which requires node.js polyfills for use on the web. We also created the https://github.com/cmdcolin/gff-nostream package to allow a non-streaming version that does not require polyfills

    • streaming parsing and streaming formatting
    • proper escaping and unescaping of attribute and column values
    • supports features with multiple locations and features with multiple parents
    • reconstructs feature hierarchies of both Parent and Derives_from relationships
    • parses FASTA sections
    • does no validation except for referential integrity of Parent and Derives_from relationships (can disable Derives_from reference checking with disableDerivesFromReferences)
    • only compatible with GFF3

    Install

    $ npm install --save @gmod/gff
    

    Usage

    const gff = require('@gmod/gff').default
    // or in ES6 (recommended)
    import gff from '@gmod/gff'
    
    const fs = require('fs')
    
    // parse a file from a file name
    // parses only features and sequences by default,
    // set options to parse directives and/or comments
    fs.createReadStream('path/to/my/file.gff3')
      .pipe(gff.parseStream({ parseAll: true }))
      .on('data', (data) => {
        if (data.directive) {
          console.log('got a directive', data)
        } else if (data.comment) {
          console.log('got a comment', data)
        } else if (data.sequence) {
          console.log('got a sequence from a FASTA section')
        } else {
          console.log('got a feature', data)
        }
      })
    
    // parse a string of gff3 synchronously
    const stringOfGFF3 = fs.readFileSync('my_annotations.gff3').toString()
    const arrayOfThings = gff.parseStringSync(stringOfGFF3)
    
    // format an array of items to a string
    const newStringOfGFF3 = gff.formatSync(arrayOfThings)
    
    // format a stream of things to a stream of text.
    // inserts sync marks automatically.
    myStreamOfGFF3Objects
      .pipe(gff.formatStream())
      .pipe(fs.createWriteStream('my_new.gff3'))
    
    // format a stream of things and write it to
    // a gff3 file. inserts sync marks and a
    // '##gff-version 3' header if one is not
    // already present
    gff.formatFile(
      myStreamOfGFF3Objects,
      fs.createWriteStream('my_new_2.gff3', { encoding: 'utf8' }),
    )

    Object format

    features

    In GFF3, features can have more than one location. We parse features as arrayrefs of all the lines that share that feature’s ID. Values that are . in the GFF3 are null in the output.

    A simple feature that’s located in just one place:

    [
      {
        "seq_id": "ctg123",
        "source": null,
        "type": "gene",
        "start": 1000,
        "end": 9000,
        "score": null,
        "strand": "+",
        "phase": null,
        "attributes": {
          "ID": ["gene00001"],
          "Name": ["EDEN"]
        },
        "child_features": [],
        "derived_features": []
      }
    ]

    A CDS called cds00001 located in two places:

    [
      {
        "seq_id": "ctg123",
        "source": null,
        "type": "CDS",
        "start": 1201,
        "end": 1500,
        "score": null,
        "strand": "+",
        "phase": "0",
        "attributes": {
          "ID": ["cds00001"],
          "Parent": ["mRNA00001"]
        },
        "child_features": [],
        "derived_features": []
      },
      {
        "seq_id": "ctg123",
        "source": null,
        "type": "CDS",
        "start": 3000,
        "end": 3902,
        "score": null,
        "strand": "+",
        "phase": "0",
        "attributes": {
          "ID": ["cds00001"],
          "Parent": ["mRNA00001"]
        },
        "child_features": [],
        "derived_features": []
      }
    ]

    directives

    parseDirective("##gff-version 3\n")
    // returns
    {
      "directive": "gff-version",
      "value": "3"
    }
    parseDirective('##sequence-region ctg123 1 1497228\n')
    // returns
    {
      "directive": "sequence-region",
      "value": "ctg123 1 1497228",
      "seq_id": "ctg123",
      "start": "1",
      "end": "1497228"
    }

    comments

    parseComment('# hi this is a comment\n')
    // returns
    {
      "comment": "hi this is a comment"
    }

    sequences

    These come from any embedded ##FASTA section in the GFF3 file.

    parseSequences(`##FASTA
    >ctgA test contig
    ACTGACTAGCTAGCATCAGCGTCGTAGCTATTATATTACGGTAGCCA`)[
      // returns
      {
        id: 'ctgA',
        description: 'test contig',
        sequence: 'ACTGACTAGCTAGCATCAGCGTCGTAGCTATTATATTACGGTAGCCA',
      }
    ]

    API

    Table of Contents

    ParseOptions

    Parser options

    disableDerivesFromReferences

    Whether to resolve references to derives from features

    Type: boolean

    encoding

    Text encoding of the input GFF3. default ‘utf8’

    Type: BufferEncoding

    parseFeatures

    Whether to parse features, default true

    Type: boolean

    parseDirectives

    Whether to parse directives, default false

    Type: boolean

    parseComments

    Whether to parse comments, default false

    Type: boolean

    parseSequences

    Whether to parse sequences, default true

    Type: boolean

    parseAll

    Parse all features, directives, comments, and sequences. Overrides other parsing options. Default false.

    Type: boolean

    bufferSize

    Maximum number of GFF3 lines to buffer, default 1000

    Type: number

    parseStream

    Parse a stream of text data into a stream of feature, directive, comment, an sequence objects.

    Parameters

    • options ParseOptions Parsing options (optional, default {})

    Returns GFFTransform stream (in objectMode) of parsed items

    parseStringSync

    Synchronously parse a string containing GFF3 and return an array of the parsed items.

    Parameters

    • str string GFF3 string
    • inputOptions ({disableDerivesFromReferences: boolean?, encoding: BufferEncoding?, bufferSize: number?} | undefined)? Parsing options

    Returns Array<(GFF3Feature | GFF3Sequence)> array of parsed features, directives, comments and/or sequences

    formatSync

    Format an array of GFF3 items (features,directives,comments) into string of GFF3. Does not insert synchronization (###) marks.

    Parameters

    • items Array<GFF3Item> Array of features, directives, comments and/or sequences

    Returns string the formatted GFF3

    formatStream

    Format a stream of features, directives, comments and/or sequences into a stream of GFF3 text.

    Inserts synchronization (###) marks automatically.

    Parameters

    • options FormatOptions parser options (optional, default {})

    Returns FormattingTransform

    formatFile

    Format a stream of features, directives, comments and/or sequences into a GFF3 file and write it to the filesystem.

    Inserts synchronization (###) marks and a ##gff-version directive automatically (if one is not already present).

    Parameters

    • stream Readable the stream to write to the file
    • writeStream Writable
    • options FormatOptions parser options (optional, default {})
    • filename the file path to write to

    Returns Promise<null> promise for null that resolves when the stream has been written

    About util

    There is also a util module that contains super-low-level functions for dealing with lines and parts of lines.

    // non-ES6
    const util = require('@gmod/gff').default.util
    // or, with ES6
    import gff from '@gmod/gff'
    const util = gff.util
    
    const gff3Lines = util.formatItem({
      seq_id: 'ctgA',
      ...
    }))

    util

    Table of Contents

    unescape

    Unescape a string value used in a GFF3 attribute.

    Parameters

    • stringVal string Escaped GFF3 string value

    Returns string An unescaped string value

    escape

    Escape a value for use in a GFF3 attribute value.

    Parameters

    Returns string An escaped string value

    escapeColumn

    Escape a value for use in a GFF3 column value.

    Parameters

    Returns string An escaped column value

    parseAttributes

    Parse the 9th column (attributes) of a GFF3 feature line.

    Parameters

    • attrString string String of GFF3 9th column

    Returns GFF3Attributes Parsed attributes

    parseFeature

    Parse a GFF3 feature line

    Parameters

    • line string GFF3 feature line

    Returns GFF3FeatureLine The parsed feature

    parseDirective

    Parse a GFF3 directive line.

    Parameters

    • line string GFF3 directive line

    Returns (GFF3Directive | GFF3SequenceRegionDirective | GFF3GenomeBuildDirective | null) The parsed directive

    formatAttributes

    Format an attributes object into a string suitable for the 9th column of GFF3.

    Parameters

    Returns string GFF3 9th column string

    formatFeature

    Format a feature object or array of feature objects into one or more lines of GFF3.

    Parameters

    Returns string A string of one or more GFF3 lines

    formatDirective

    Format a directive into a line of GFF3.

    Parameters

    Returns string A directive line string

    formatComment

    Format a comment into a GFF3 comment. Yes I know this is just adding a # and a newline.

    Parameters

    Returns string A comment line string

    formatSequence

    Format a sequence object as FASTA

    Parameters

    Returns string Formatted single FASTA sequence string

    formatItem

    Format a directive, comment, sequence, or feature, or array of such items, into one or more lines of GFF3.

    Parameters

    Returns (string | Array<string>) A formatted string or array of strings

    GFF3Attributes

    A record of GFF3 attribute identifiers and the values of those identifiers

    Type: Record<string, (Array<string> | undefined)>

    GFF3FeatureLine

    A representation of a single line of a GFF3 file

    seq_id

    The ID of the landmark used to establish the coordinate system for the current feature

    Type: (string | null)

    source

    A free text qualifier intended to describe the algorithm or operating procedure that generated this feature

    Type: (string | null)

    type

    The type of the feature

    Type: (string | null)

    start

    The start coordinates of the feature

    Type: (number | null)

    end

    The end coordinates of the feature

    Type: (number | null)

    score

    The score of the feature

    Type: (number | null)

    strand

    The strand of the feature

    Type: (string | null)

    phase

    For features of type “CDS”, the phase indicates where the next codon begins relative to the 5′ end of the current CDS feature

    Type: (string | null)

    attributes

    Feature attributes

    Type: (GFF3Attributes | null)

    GFF3FeatureLineWithRefs

    Extends GFF3FeatureLine

    A GFF3 Feature line that includes references to other features defined in their “Parent” or “Derives_from” attributes

    child_features

    An array of child features

    Type: Array<GFF3Feature>

    derived_features

    An array of features derived from this feature

    Type: Array<GFF3Feature>

    GFF3Feature

    A GFF3 feature, which may include multiple individual feature lines

    Type: Array<GFF3FeatureLineWithRefs>

    GFF3Directive

    A GFF3 directive

    directive

    The name of the directive

    Type: string

    value

    The string value of the directive

    Type: string

    GFF3SequenceRegionDirective

    Extends GFF3Directive

    A GFF3 sequence-region directive

    value

    The string value of the directive

    Type: string

    seq_id

    The sequence ID parsed from the directive

    Type: string

    start

    The sequence start parsed from the directive

    Type: string

    end

    The sequence end parsed from the directive

    Type: string

    GFF3GenomeBuildDirective

    Extends GFF3Directive

    A GFF3 genome-build directive

    value

    The string value of the directive

    Type: string

    source

    The genome build source parsed from the directive

    Type: string

    buildName

    The genome build name parsed from the directive

    Type: string

    GFF3Comment

    A GFF3 comment

    comment

    The text of the comment

    Type: string

    GFF3Sequence

    A GFF3 FASTA single sequence

    id

    The ID of the sequence

    Type: string

    description

    The description of the sequence

    Type: string

    sequence

    The sequence

    Type: string

    License

    MIT © Robert Buels

    Visit original content creator repository https://github.com/GMOD/gff-js
  • react-native-fusioncharts

    FusionCharts - Build beautiful web & mobile dashboards

    React Native FusionCharts

    Welcome to the official GitHub repository for the React Native FusionCharts component! This component provides seamless bindings for the FusionCharts JavaScript Charting Library, allowing you to effortlessly integrate rich and interactive charts into your React Native projects.

    Enhance your applications with our diverse range of charts designed to meet all your data visualization needs. Get started today and bring your data to life!

    Table of Contents

    Here’s the updated GitHub documentation with rephrased section headings and modified slugs:

    Important Links

    Introduction

    React Native FusionCharts version 6.0.0 is compatible with the following versions of Expo and React Native. While it is possible that version 6.0.0 may function with newer versions of React Native and Expo, it has only been tested up to React Native 74.5.

    Expo SDK Versions React Native Versions
    47, 48, 49, 50 & 51 >=0.70.8 & <=0.74.5

    Overview

    To quickly integrate React Native FusionCharts, follow these essential steps. This process installs all required dependencies, allowing those already familiar with FusionCharts to get up and running quickly. If you are new to FusionCharts, referring the Getting Started section will be more helpful.

    1. Initial Dependencies Installation: Begin by running the following command in your project directory to install the necessary dependencies:

      npm i react-native-webview @notifee/react-native @react-native-camera-roll/camera-roll react-native-fs react-native-share
      
    2. Installing React Native FusionCharts: Next, install the react-native-fusioncharts package:

      npm install react-native-fusioncharts
      
    3. iOS Setup: For iOS applications, navigate to your ios directory and execute:

      pod install
      
    4. Enabling Chart Export Functionality on iOS: To add export functionality for your charts in iOS, modify your info.plist file by adding the following code to request photo library access:

      <key>NSPhotoLibraryUsageDescription</key>
      <string>Photo Library Access for downloading the chart</string>

    Now that you have all essential components integrated into your project. You can now check the the quick start guide to render a chart or explore the APIs.

    Getting Started

    Requirements

    Node.js, NPM/Yarn installed globally in your OS.

    Installation

    React Native FusionCharts can be integrated into applications using Expo tools or bare React Native environments.

    Developing Applications with FusionCharts and Expo

    1. Make sure you have Node.js and Git installed in your environment. Check the official Expo’s documentation for more details.

    2. Run the following command in terminal to create a new application and navigate in the project directory. You can check here for more details on creating an new expo app.

    npx create-expo-app FusionApp --template blank && cd FusionApp
    
    1. Install React Native FusionCharts:
    npm i react-native-fusioncharts
    
    1. Install dependencies for React Native FusionCharts:
    npm i react-native-webview @notifee/react-native @react-native-camera-roll/camera-roll react-native-fs react-native-share
    
    1. Replace the code in the “App.js” file and replace it with the example here

    2. Run the npx expo start in the project directory and expo should generate a QR-code that you can scan from your iOS camera app to open Expo Go or directly from the Expo Go app in an android device. Make sure your device and system is on the same network.

    3. If everything went well so far then you should be able to see FusionCharts sample column2D chart on the app.

    Creating an App with FusionCharts using React Native CLI

    This guide is for building an app from scratch using React Native without any framework. If you already have an existing app, then please check the overview section and examples to setup FusionCharts.

    The initial steps(1-5) to setup the React Native app is taken from the official React Native guide to setup a new app. Please refer to the React Native documentation in case you encounter an issue setting up your app.

    1. If you previously installed a global react-native-cli package, please remove it as it may cause unexpected issues:
    npm uninstall -g react-native-cli @react-native-community/cli
    
    1. Use React Native Community CLI to generate a new project.
    npx @react-native-community/cli@latest init FusionApp && cd FusionApp
    
    1. Install React Native FusionCharts:
    npm i react-native-fusioncharts
    
    1. Install dependencies for React Native FusionCharts:
    npm i react-native-webview @notifee/react-native @react-native-camera-roll/camera-roll react-native-fs react-native-share
    
    1. Start Metro (Metro is the JavaScript build tool for React Native. To start the Metro development server, run the following from your project folder)
    npm start
    
    1. Start your application. Let Metro Bundler run in its own terminal. Open a new terminal inside your React Native project folder. Run the following:
    npm run android
    # or
    npm run ios
    1. If everything is set up correctly, you should see your new app running in your Android/iOS emulator shortly.

    2. Now open App.tsx in your text editor of choice and add chart samples from the quick start section to render FusionCharts in your app. You can find more chart samples in our official documentation

    Quick Start

    Include the react-native-fusioncharts library as follows:

    The App.js file:

    import React from "react";
    import { Text, View } from "react-native";
    import ReactNativeFusionCharts from "react-native-fusioncharts";
    
    const Chart = () => {
      const chartData = [
        { label: "Venezuela", value: "250" },
        { label: "Saudi", value: "260" },
        { label: "Canada", value: "180" },
        { label: "Iran", value: "140" },
        { label: "Russia", value: "115" },
        { label: "UAE", value: "100" },
        { label: "US", value: "30" },
        { label: "China", value: "30" },
      ];
      const chartConfig = {
        type: "column2D",
        width: "300",
        height: "400",
        dataFormat: "json",
        dataSource: {
          chart: {
            caption: "Countries With Most Oil Reserves [2017-18]",
            subCaption: "In MMbbl = One Million barrels",
            xAxisName: "Country",
            yAxisName: "Reserves (MMbbl)",
            numberSuffix: "K",
            theme: "fusion",
            exportEnabled: 1, // to enable the export chart functionality
          },
          data: chartData,
        },
      };
      return (
        <View
          style={{
            flex: 1,
            justifyContent: "center",
            alignItems: "center",
            marginTop: 50,
          }}
        >
          <Text>Fusioncharts</Text>
          <ReactNativeFusionCharts chartConfig={chartConfig} />
        </View>
      );
    };
    export default Chart;

    Event Handling

    In this sample we are attaching dataplotclick event in the chart.

    import { StatusBar } from "expo-status-bar";
    import { StyleSheet, Text, View, Alert } from "react-native";
    import ReactNativeFusionCharts from "react-native-fusioncharts";
    
    export default function App() {
      const chartData = [
        { label: "Venezuela", value: "250" },
        { label: "Saudi", value: "260" },
        { label: "Canada", value: "180" },
        { label: "Iran", value: "140" },
        { label: "Russia", value: "115" },
        { label: "UAE", value: "100" },
        { label: "US", value: "30" },
        { label: "China", value: "30" },
      ];
      const chartConfig = {
        type: "column2D",
        width: "300",
        height: "400",
        dataFormat: "json",
        dataSource: {
          chart: {
            caption: "Countries With Most Oil Reserves [2017-18]",
            subCaption: "In MMbbl = One Million barrels",
            xAxisName: "Country",
            yAxisName: "Reserves (MMbbl)",
            numberSuffix: "K",
            theme: "fusion",
            exportEnabled: 1, // to enable the export chart functionality
          },
          data: chartData,
        },
      };
      const events = {
        // Add your events method here:
        // Event name should be in small letters.
        dataplotclick: (e, a) => {
          Alert.alert(`You clicked on ${e.data.categoryLabel}`);
        },
      };
      return (
        <View style={styles.container}>
          <Text>Fusioncharts</Text>
          <ReactNativeFusionCharts chartConfig={chartConfig} events={events} />
          <StatusBar style="auto" />
        </View>
      );
    }
    
    const styles = StyleSheet.create({
      container: {
        flex: 1,
        backgroundColor: "#fff",
        alignItems: "center",
        justifyContent: "center",
        marginTop: 50,
      },
    });

    API Integration

    In this sample we can change the chart type dynamically using chart APIs.

    import React, { Component } from "react";
    import { Platform, StyleSheet, Text, View, Button, Alert } from "react-native";
    import ReactNativeFusionCharts from "react-native-fusioncharts";
    
    export default class ChartRunTime extends Component {
      constructor(props) {
        super(props);
        // Create a property(e.g: apiCaller) which will get attached to a function
        // where you can pass Chart API methods you want to run.
        this.apiCaller = null;
        const chartConfig = {
          type: "column2d",
          width: "100%",
          height: "100%",
          dataFormat: "json",
          dataSource: {
            chart: {
              caption: "Recommended Portfolio Split",
              subCaption: "For a net-worth of $1M",
              showValues: "1",
              showPercentInTooltip: "0",
              numberPrefix: "$",
              enableMultiSlicing: "1",
              theme: "fusion",
              exportEnabled: 1,
            },
            data: [
              {
                label: "Equity",
                value: "300000",
              },
              {
                label: "Debt",
                value: "230000",
              },
              {
                label: "Bullion",
                value: "180000",
              },
              {
                label: "Real-estate",
                value: "270000",
              },
              {
                label: "Insurance",
                value: "20000",
              },
            ],
          },
        };
    
        this.state = {
          chartConfig,
          chartType: "",
        };
      }
    
      changeType(type) {
        this.setState({ chartType: type }, () => {
          // Chart instance is available here.
          // Passing js code to run chart api method.
          this.apiCaller(`chartType('${type}')`); // This method accepts js code in string.
        });
      }
    
      // Bind the argument from onInitialized with the property you created in your constructor
      bindApiCaller(caller) {
        // Now this.apiCaller will be a function where you can pass js code for the WebView
        // to access the chart Object. See the method changeType.
        this.apiCaller = caller;
        if (this.state.chartType === "") this.setState({ chartType: this.state.type });
      }
    
      render() {
        return (
          <View style={styles.container}>
            <Text style={styles.header}>Change chart type at runtime</Text>
            <View style={styles.chartContainer}>
              <ReactNativeFusionCharts
                chartConfig={this.state.chartConfig}
                onInitialized={(caller) => {
                  this.bindApiCaller(caller);
                }}
              />
            </View>
            <Text style={styles.info}>Press button to change chart type</Text>
            <View style={styles.buttonContainer}>
              <Button
                disabled={this.state.chartType === "" || this.state.chartType == "column2d"}
                style={{ margin: 8 }}
                title="Column2D"
                onPress={() => this.changeType("column2d")}
              />
              <Button
                disabled={this.state.chartType === "" || this.state.chartType == "pie2d"}
                title="Pie2D"
                onPress={() => this.changeType("pie2d")}
              />
              <Button
                disabled={this.state.chartType === "" || this.state.chartType == "bar2d"}
                title="Bar2D"
                onPress={() => this.changeType("bar2d")}
              />
            </View>
          </View>
        );
      }
    }
    
    const styles = StyleSheet.create({
      container: {
        flex: 1,
        padding: 10,
      },
      header: {
        fontWeight: "bold",
        fontSize: 20,
        textAlign: "center",
        paddingBottom: 10,
      },
      chartContainer: {
        height: 400,
        borderColor: "#000",
        borderWidth: 1,
      },
      buttonContainer: {
        padding: 10,
        display: "flex",
        justifyContent: "space-around",
        flexDirection: "row",
        alignItems: "center",
      },
      info: {
        fontSize: 16,
        textAlign: "center",
        marginTop: 5,
      },
    });

    Module Management

    In this sample we can add the modules dynamically e.g gantt, timeseries, powercharts etc

    import React, { Component } from "react";
    import { StyleSheet, View } from "react-native";
    import ReactNativeFusionCharts from "react-native-fusioncharts";
    
    export default class App extends Component {
      constructor(props) {
        super(props);
    
        const chartConfig = {
          type: "gantt", // your chart type goes here
          width: "100%",
          height: "400",
          dataFormat: "json",
          dataSource: {
            // your data goes here
            // for gantt chart data please visit https://www.fusioncharts.com/dev/chart-attributes/gantt
          },
        };
        this.state = {
          chartConfig,
        };
      }
    
      render() {
        const modules = ["gantt"]; // module names goes here
        return (
          <View style={styles.container}>
            <View style={styles.chartContainer}>
              <ReactNativeFusionCharts chartConfig={this.state.chartConfig} modules={modules} />
            </View>
          </View>
        );
      }
    }
    
    const styles = StyleSheet.create({
      container: {
        flex: 1,
        padding: 10,
      },
    
      chartContainer: {
        height: "60%",
        borderColor: "#000",
        borderWidth: 1,
      },
    });

    In this sample we can add the theme modules dynamically e.g candy, carbon, gammel etc

    import React, { Component } from "react";
    import { Platform, StyleSheet, Text, View, Alert } from "react-native";
    import ReactNativeFusionCharts from "react-native-fusioncharts";
    
    export default class ListenEvents extends Component {
      constructor(props) {
        super(props);
    
        const chartConfig = {
          type: "column2d",
          width: "100%",
          height: "100%",
          dataFormat: "json",
          dataSource: {
            chart: {
              caption: "Countries With Most Oil Reserves [2017-18]",
              subCaption: "In MMbbl = One Million barrels",
              xAxisName: "Country",
              yAxisName: "Reserves (MMbbl)",
              numberSuffix: "K",
              theme: "carbon", // your theme name goes here
              exportEnabled: 1,
            },
            data: [
              { label: "Venezuela", value: "290" },
              { label: "Saudi", value: "260" },
              { label: "Canada", value: "180" },
              { label: "Iran", value: "140" },
              { label: "Russia", value: "115" },
              { label: "UAE", value: "100" },
              { label: "US", value: "30" },
              { label: "China", value: "30" },
            ],
          },
        };
    
        this.state = {
          chartConfig,
        };
      }
    
      render() {
        const modules = ["carbon"]; // theme module name
        return (
          <View style={styles.container}>
            <Text style={styles.header}>Listen to events from chart</Text>
            <View style={styles.chartContainer}>
              <ReactNativeFusionCharts chartConfig={this.state.chartConfig} modules={modules} />
            </View>
          </View>
        );
      }
    }
    
    const styles = StyleSheet.create({
      container: {
        flex: 1,
        padding: 10,
      },
      header: {
        fontWeight: "bold",
        fontSize: 20,
        textAlign: "center",
        paddingBottom: 10,
      },
      chartContainer: {
        height: 400,
        borderColor: "#000",
        borderWidth: 1,
      },
    });

    Setting Up Licenses

    If you are using a licensed verison of fusioncharts and have a valid license key, add the license object by either creating a new file with your license configuration inside it and import it in app.js or add ‘global.licenseConfig’ object to the app.js file as shown below

    import React, { Component } from "react";
    import { StyleSheet, View } from "react-native";
    import ReactNativeFusionCharts from "react-native-fusioncharts";
    
    global.licenseConfig = {
      key: "your key goes here",
      creditLabel: false, // true/false to show/hide watermark respectively
    };
    export default class App extends Component {
      constructor(props) {
        super(props);
    
        const chartConfig = {
          type: "column2D",
          width: "100%",
          height: "400",
          dataFormat: "json",
          dataSource: {
            chart: {
              caption: "Countries With Most Oil Reserves [2017-18]",
              subCaption: "In MMbbl = One Million barrels",
              xAxisName: "Country",
              yAxisName: "Reserves (MMbbl)",
              numberSuffix: "K",
              theme: "fusion",
              exportEnabled: 1,
            },
            data: [
              { label: "Venezuela", value: "250" },
              { label: "Saudi", value: "260" },
              { label: "Canada", value: "180" },
              { label: "Iran", value: "140" },
              { label: "Russia", value: "115" },
              { label: "UAE", value: "100" },
              { label: "US", value: "30" },
              { label: "China", value: "30" },
            ],
          },
        };
        this.state = {
          chartConfig,
        };
      }
    
      render() {
        return (
          <View style={styles.container}>
            <View style={styles.chartContainer}>
              <ReactNativeFusionCharts chartConfig={this.state.chartConfig} />
            </View>
          </View>
        );
      }
    }
    
    const styles = StyleSheet.create({
      container: {
        flex: 1,
        padding: 10,
      },
    
      chartContainer: {
        height: "60%",
        borderColor: "#000",
        borderWidth: 1,
      },
    });

    FusionTime Integration

    From fusioncharts@3.13.3-sr.1 and react-native-fusioncharts@3.0.0, You can visualize timeseries data easily on react.

    Learn more about FusionTime here.

    Example Integration

    // In App.js
    import React, { Component } from "react";
    import { AppRegistry, StyleSheet, Text, View, Platform } from "react-native";
    import ReactNativeFusionCharts from "react-native-fusioncharts";
    
    export default class App extends Component {
      constructor(props) {
        super(props);
    
        const chartConfig = {
          type: "timeseries",
          width: "100%",
          height: "100%",
          dataFormat: "json",
          dataSource: {
            data: null,
            caption: {
              text: "Sales Analysis",
            },
            subcaption: {
              text: "Grocery",
            },
            yAxis: [
              {
                plot: {
                  value: "Grocery Sales Value",
                  type: "line",
                },
                format: {
                  prefix: "$",
                },
                title: "Sale Value",
              },
            ],
          },
          schemaJson: null,
          dataJson: null,
        };
    
        this.state = {
          chartConfig,
        };
      }
    
      componentDidMount() {
        this.fetchDataAndSchema();
      }
    
      fetchDataAndSchema() {
        const jsonify = (res) => res.json();
        const dFetch = fetch(
          "https://s3.eu-central-1.amazonaws.com/fusion.store/ft/data/line-chart-with-time-axis-data.json"
        ).then(jsonify);
        // This is the remote url to fetch the schema.
        const sFetch = fetch(
          "https://s3.eu-central-1.amazonaws.com/fusion.store/ft/schema/line-chart-with-time-axis-schema.json"
        ).then(jsonify);
        Promise.all([dFetch, sFetch]).then((res) => {
          const data = res[0];
          const schema = res[1];
          const updatedChartConfig = { ...this.state.chartConfig, dataJson: data, schemaJson: schema };
          this.setState({ chartConfig: updatedChartConfig });
        });
      }
    
      render() {
        const modules = ["timeseries"];
    
        return (
          <View style={styles.container}>
            <Text style={styles.heading}>FusionCharts Integration with React Native</Text>
            <View style={styles.chartContainer}>
              <ReactNativeFusionCharts chartConfig={this.state.chartConfig} modules={modules} />
            </View>
          </View>
        );
      }
    }
    
    const styles = StyleSheet.create({
      container: {
        flex: 1,
        padding: 10,
      },
      heading: {
        fontSize: 20,
        textAlign: "center",
        marginBottom: 10,
      },
      chartContainer: {
        height: 500,
      },
    });

    Going Beyond Charts

    • Explore 20+ pre-built business specific dashboards for different industries like energy and manufacturing to business functions like sales, marketing and operations here.
    • See Data Stories built using FusionCharts’ interactive JavaScript visualizations and learn how to communicate real-world narratives through underlying data to tell compelling stories.

    Contributor Guidelines

    #  Clone repo
    git clone git@github.com:fusioncharts/react-native-fusioncharts.git
    cd react-native-fusioncharts
    
    # Install dependencies
    npm install
    
    # Run
    npm run start
    
    # Build
    npm run build
    
    # Publish
    npm publish

    License Information

    The FusionCharts React Native integration component is open-source and distributed under the terms of the MIT/X11 License. However, you will need to download and include FusionCharts library in your page separately, which has a separate license.

    Visit original content creator repository https://github.com/fusioncharts/react-native-fusioncharts
  • Realestate

    Depreciated

    Project is no longer able to grab home data from Redfin.

    Real Estate Heat Map /Historic Price Trend Indicator.

    This is an individual project for nation wide heat map of the U.S. by county, and can be viewed downed to the city for more accurate representation and details on a city level.

    Currently a working progress. Main issue is the amount of data to be process (CT alone has 1015948 known addresses) ,and as of right now after modifying Redfin unofficial api (https://pypi.org/project/redfin/) and running the code in parallel give us about 40-60 address computed per second. This is after removing several duplicate addresses and addresses that are likely to be apartments. Without a backing of an organization to use Zillow API for faster request time or more request it is feasibly impossible to run the code alone on a personal computer for a nation wide scale.

    A more likely option is to only keep track of a city or state instead of the entire U.S. if used for personal reasons.

    Tech Stack: Python3, SQLite3, Node.js, Express.js

    Prequiste

    • Anaconda
    • Vscode
    • Python3
    • Node.js
    • some kind of Zip file unpacker
    • Npm
    • Pip

    Everything should be installed in an Anaconda env.

    Install libraries

    npm install express sqlite3 body-parser child_process gridstack  tablefilter
    
    pip install requests aiohttp tqdm pandas numpy tensorflow scikit-learn
    

    Intial Setup

    Download the region of realestate to look at from openAddress.io; this will reguire you to have an account with openAddress.io. Would recommend only downloading the files for the region you want to look at as the files downloaded are quite large and with file processing and creation the code size will be quite large (rough estimate with all states/regions ~150gb).

    Unpack the downloaded files and drop them in \Realestae\downloads folder. Run the following command in the root directory. This will start collecting data from state you want to look at, depending on the state this will take a while. A 100,000 address takes about 42 minutes this is with 32gb ram. The code can be ran in chunks so if you are not able to run the code for several hours you can run the code in increments of 100,000(more or less) untill you have grab all the address from the state. If ran with 100,000 the first time, then to grab the next 100,000 you will need to modify the -i flag to be “-i 200000”.

    python3 setup.py -i 1000 -n ct -f
    

    -i flag for how many address to be proccess(Required). The value after is the number of addresses to be processed.

    -n flag for the state to be proccess(Required). The value after is the state name abbreviation of addresses to be processed.

    -f flag to convert the file and remove unnecessary addresses. Only need to use the flag once for the first run of a new state(Optional).

    Dispaly Web App

    Will start the webpage with all the data collected and display the chart.

    npm run start
    

    Price Prediction

    It is recommended that you have collected all the addresses from setup.py before executing the code below as the model will perform better with more data.

    python3 ml_setup.py [city_name]
    

    Replace [city_name] with a name of a city from the data you have collected.

    To be implemented

    • Add assets and restructure webpage from/with Figma
    • Hosting the code at Vercel with a demo database to grab property data
    • Containarize code
    • Add feature for process_geojson_data() to write in batches while collecting data instead of after
    • Connect front end to back end machine learning price prediction
    • Create enviroment file
    • Testing modules
    Visit original content creator repository https://github.com/DaemonCypher/Realestate
  • CongresoTIC

    Ionic 2 Conference Application

    This is purely a demo of Ionic 2 with TypeScript. It is still in development.

    Important!

    There is not an actual Ionic Conference at this time. This project is just to show off Ionic 2 components in a real-world application. Please go through the steps in CONTRIBUTING.md before submitting an issue.

    Table of Contents

    Getting Started

    • Clone this repository.
    • Want to use TypeScript? Both the master branch and the typescript branch now use TypeScript.
    • Run npm install from the project root.
    • Install the ionic CLI (npm install -g ionic)
    • Run ionic serve in a terminal from the project root.
    • Profit

    Note: Is your build slow? Update npm to 3.x: npm install -g npm.

    Contributing

    See CONTRIBUTING.md 🎉👍

    Use Cases

    App Preview

    All app preview screenshots were taken by running ionic serve --lab on a retina display.

    File Structure of App

    ionic-conference-app/
    ├-- .github/                            * GitHub files
    │   ├── CONTRIBUTING.md                 * Documentation on contributing to this repo
    │   └── ISSUE_TEMPLATE.md               * Template used to populate issues in this repo
    |
    |-- resources/
    |
    |-- src/
    |    |-- app/
    |    |    ├── app.component.ts
    |    |    └── app.module.ts
    |    |    └── app.template.html
    |    |    └── main.dev.ts
    |    |    └── main.prod.ts
    |    |
    |    |-- assests/
    |    |    ├── data/
    |    |    |    └── data.json
    |    |    |
    |    |    ├── fonts/
    |    |    |     ├── ionicons.eot
    |    |    |     └── ionicons.svg
    |    |    |     └── ionicons.ttf
    |    |    |     └── ionicons.woff
    |    |    |     └── ionicons.woff2
    |    |    |
    |    |    ├── img/
    |    |
    |    |-- pages/                          * Contains all of our pages
    │    │    ├── about/                     * About tab page
    │    │    │    ├── about.html            * AboutPage template
    │    │    │    └── about.ts              * AboutPage code
    │    │    │    └── about.scss            * AboutPage stylesheet
    │    │    │
    │    │    ├── account/                   * Account page
    │    │    │    ├── account.html          * AccountPage template
    │    │    │    └── account.ts            * AccountPage code
    │    │    │    └── account.scss          * AccountPage stylesheet
    │    │    │
    │    │    │── login/                     * Login page
    │    │    │    ├── login.html            * LoginPage template
    │    │    │    └── login.ts              * LoginPage code
    │    │    │    └── login.scss            * LoginPage stylesheet
    │    │    │
    │    │    │── map/                       * Map tab page
    │    │    │    ├── map.html              * MapPage template
    │    │    │    └── map.ts                * MapPage code
    │    │    │    └── map.scss              * MapPage stylesheet
    │    │    │
    │    │    │── schedule/                  * Schedule tab page
    │    │    │    ├── schedule.html         * SchedulePage template
    │    │    │    └── schedule.ts           * SchedulePage code
    │    │    │    └── schedule.scss         * SchedulePage stylesheet
    │    │    │
    │    │    │── schedule-filter/            * Schedule Filter page
    │    │    │    ├── schedule-filter.html   * ScheduleFilterPage template
    │    │    │    └── schedule-filter.ts     * ScheduleFilterPage code
    │    │    │    └── schedule-filter.scss   * ScheduleFilterPage stylesheet
    │    │    │
    │    │    │── session-detail/            * Session Detail page
    │    │    │    ├── session-detail.html   * SessionDetailPage template
    │    │    │    └── session-detail.ts     * SessionDetailPage code
    │    │    │
    │    │    │── signup/                    * Signup page
    │    │    │    ├── signup.html           * SignupPage template
    │    │    │    └── signup.ts             * SignupPage code
    │    │    │
    │    │    │── speaker-detail/            * Speaker Detail page
    │    │    │    ├── speaker-detail.html   * SpeakerDetailPage template
    │    │    │    └── speaker-detail.ts     * SpeakerDetailPage code
    │    │    │    └── speaker-detail.scss   * SpeakerDetailPage stylesheet
    │    │    │
    │    │    │── speaker-list/              * Speakers tab page
    │    │    │    ├── speaker-list.html     * SpeakerListPage template
    │    │    │    └── speaker-list.ts       * SpeakerListPage code
    │    │    │    └── speaker-list.scss     * SpeakerListPage stylesheet
    │    │    │
    │    │    │── tabs/                      * Tabs page
    │    │    │    ├── tabs.html             * TabsPage template
    │    │    │    └── tabs.ts               * TabsPage code
    │    │    │
    │    │    └── tutorial/                  * Tutorial Intro page
    │    │         ├── tutorial.html         * TutorialPage template
    │    │         └── tutorial.ts           * TutorialPage code
    │    │         └── tutorial.scss         * TutorialPage stylesheet
    |    |
    │    ├── providers/                      * Contains all Injectables
    │    │     ├── conference-data.ts        * ConferenceData code
    │    │     └── user-data.ts              * UserData code
    │    ├── theme/                          * App theme files
    |    |     ├── variables.scss            * App Shared Sass Variables
    |    |
    |    |-- index.html
    |
    |-- www/
    |    ├── assets/
    |    |    ├── data/
    |    |    |    └── data.json
    |    |    |
    |    |    ├── fonts/
    |    |    |     ├── ionicons.eot
    |    |    |     └── ionicons.svg
    |    |    |     └── ionicons.ttf
    |    |    |     └── ionicons.woff
    |    |    |     └── ionicons.woff2
    |    |    |
    |    |    ├── img/
    |    |
    |    └── build/
    |    └── index.html
    |
    ├── .editorconfig                       * Defines coding styles between editors
    ├── .gitignore                          * Example git ignore file
    ├── LICENSE                             * Apache License
    ├── README.md                           * This file
    ├── config.xml                          * Cordova configuration file
    ├── ionic.config.json                   * Ionic configuration file
    ├── package.json                        * Defines our JavaScript dependencies
    ├── tsconfig.json                       * Defines the root files and the compiler options
    ├── tslint.json                         * Defines the rules for the TypeScript linter
    
    Visit original content creator repository https://github.com/juliandavidmr/CongresoTIC
  • ico-contracts

    EARNET Project

    • The ICO contracts of EARNET project.
    • If you have any questions, please connect with us on our social channels.

    Contracts

    1. EarnetToken
      • The contract of the standard token.
    2. Earnet1stPresale
      • The contract of the 1st pre sale, non lock up time.
    3. Earnet1st1mPresale
      • The contract of the 1st pre sale, lock up for one month from the exchange listing.
    4. Earnet1st3mPresale
      • The contract of the 1st pre sale, lock up for three months from the exchange listing.
    5. Earnet1st6mPresale
      • The contract of the 1st pre sale, lock up for six months from the exchange listing.
    6. Earnet2ndPresale
      • The contract of the 2nd pre sale, non lock up time.
    7. Earnet2nd1mPresale
      • The contract of the 2nd pre sale, lock up for one month from the exchange listing.
    8. Earnet2nd3mPresale
      • The contract of the 2nd pre sale, lock up for three months from the exchange listing.
    9. Earnet2nd6mPresale
      • The contract of the 2nd pre sale, lock up for six months from the exchange listing.
    10. EarnetCrowdsale
      • The contract of the crowd sale, non lock up time.
    11. Earnet1mCrowdsale
      • The contract of the crowd sale, lock up for one month from the exchange listing.
    12. Earnet3mCrowdsale
      • The contract of the crowd sale, lock up for three months from the exchange listing.
    13. Earnet6mCrowdsale
      • The contract of the crowd sale, lock up for six months from the exchange listing.
    14. EarnetTokwnPool
      • The contract of the lock up token for one month.
    15. Earnet3mTokwnPool
      • The contract of the lock up token for three months.
    16. Earnet6mTokwnPool
      • The contract of the lock up token for six months.
    17. EarnetWhitelist
      • The contract that records whitelist into the storage.
    18. EarnetWhitelistedCrowdsale
      • The contract which extends in the sale contract in order to use the whitelist.

    Methods

    • EarnetToken

    ID Name Scope param return value Note
    1 name public ERC20
    2 symbol public ERC20
    3 decimals public ERC20
    4 totalSupply public int ERC20
    5 balanceOf public address int ERC20
    6 transfer public to_address, int bool ERC20
    7 transferFrom public to_address, from_adress, int bool ERC20
    8 approve public ERC20
    9 allowance public ERC20
    10 mint public Zeppelin-solidity
    11 burn public Zeppelin-solidity

    • Earnet1stPresale, Earnet1st1mPresale, Earnet1st3mPresale, Earnet1st6mPresale, Earnet2ndPresale, Earnet2nd1mPresale, Earnet2nd3mPresale, Earnet2nd6mPresale, EarnetCrowdsale, Earnet1mCrowdsale, Earnet3mCrowdsale, Earnet6mCrowdsale

    ID Name Scope param return value Note
    1 crowdsale public
    2 buyTokens public address int
    3 pause public Zeppelin-solidity
    4 unpause public Zeppelin-solidity
    5 hasClosed public bool Zeppelin-solidity
    6 setVolume external _weiAmount, _rate

    • EarnetTokenPool, Earnet3mTokenPool, Earnet6mTokenPool,

    ID Name Scope param return value Note
    1 deposit public address, amount bool
    2 contributable public address bool
    3 checkdeposit public bool
    4 withdraw public address, wallet bool
    5 unlock public
    6 managerble public address

    • EarnetWhitelist

    ID Name Scope param return value Note
    1 addToWhitelist public address
    2 addManyToWhitelist public address
    3 removeFromWhitelist public address
    4 removeManyFromWhitelist public address
    5 isWhitelisted public address bool


    Prerequisite

    Language

    • solidity 0.4.23

    Framework

    • truffle 4.1.1

    Library

    • zeppelin-solidity 1.9.0

    Package manager

    • npm 6.1.0

    Test tool

    • ropsten
    • ganache 1.1.0-beta.0

    Ethereum client

    • Geth 1.8.3

    Version manager

    • Github

    License


    Code audit

    Visit original content creator repository
    https://github.com/EARNET/ico-contracts

  • restaurant-location-search-api 🍔🍹

    restaurant-location-search-api 🍔🍹

    A Node.js package that serves as an unofficial API wrapper, providing a unified interface to fetch restaurant locations from various chains without the need for Google Maps API, making it a cost-free solution. This package leverages the specific, unofficial APIs of supported restaurants such as McDonald’s, Wendy’s, Chipotle, Burger King, Popeyes, and Taco Bell, offering a simplified way to retrieve locations based on latitude and longitude. It’s designed for developers who need to integrate restaurant location functionalities into their applications seamlessly, with plans to expand support to more restaurant chains in the future.

    Features

    • Fetch the nearest or a list of restaurant locations based on coordinates.
    • Supports multiple restaurant chains.
    • Option to specify search radius and maximum number of results.
    • Handles responses in various formats, including JSON and XML, automatically decoding compressed responses.
    • Search sites for more info ( coming soon )

    Installation

    Use npm to install restaurant-location-search-api:

    npm install restaurant-location-search-api

    Usage

    After installation, require the package in your Node.js project and use the functions provided to fetch restaurant locations.

    const getLocations = require('restaurant-location-search-api');
    
    // Fetch nearest McDonald's location
    getLocations('tacoBell', { lat: 40.712776, long: -74.005974 }, '1000', '1', true)
      .then(fetchedLocations => { console.log( fetchedLocations ) } )
      .catch(console.error);
    
    // Fetch locations for other supported restaurants
    getLocations('burgerKing', { lat: 40.712776, long: -74.005974 }, '5000', '5')
      .then(fetchedLocations => { console.log( fetchedLocations ) } )
      .catch(console.error);

    API

    getLocations(spotName, geoObject, radius, maxResults, nearbyOnly=false)

    Fetches restaurant locations based on the specified parameters.

    • spotName: Name of the restaurant chain (e.g., ‘mcdonalds’, ‘wendys’).
    • geoObject: Object with lat (latitude) and long (longitude) properties.
    • radius: Search radius in kilometers.
    • maxResults: Maximum number of results to return.
    • nearbyOnly (optional): Set to true to fetch only the nearest location. ( might not work for all restuarants )

    Example JSON Response

    Below is an example of the JSON response returned by the getLocations function for Taco Bell locations:

    {
      "nearByStores": [
        {
          "storeStatus": "openNow",
          "pickupStoreStatusForLocation": "Activated",
          "phoneNumber": "+12122330848",
          "storeNumber": "035336",
          "timeZone": "GMT-05:00",
          "roundUpFlag": true,
          "todayBusinessHours": {
            "openTime": "07:00",
            "closeTime": "23:00"
          },
          "delivery": true,
          "address": {
            "streetAddress": "123 Example St",
            "city": "New York",
            "state": "NY",
            "zipCode": "10001"
          },
          "geoPoint": {
            "latitude": 40.712776,
            "longitude": -74.005974
          },
          "formattedDistance": "0.30 Miles"
        },
        {
          "storeStatus": "openNow",
          "pickupStoreStatusForLocation": "Activated",
          "phoneNumber": "+16468239315",
          "storeNumber": "035828",
          "timeZone": "GMT-05:00",
          "roundUpFlag": true,
          "todayBusinessHours": {
            "openTime": "07:00",
            "closeTime": "22:00"
          },
          "delivery": true,
          "address": {
            "streetAddress": "456 Another Rd",
            "city": "New York",
            "state": "NY",
            "zipCode": "10002"
          },
          "geoPoint": {
            "latitude": 40.715776,
            "longitude": -74.015974
          },
          "formattedDistance": "1.1 Miles"
        }
        // Additional stores omitted for brevity
      ]
    }

    Supported Restaurants

    • McDonald’s
    • Wendy’s
    • Chipotle
    • Burger King
    • Popeyes
    • Taco Bell

    More coming soon!

    Contributing

    Contributions are welcome! If you’d like to add support for more restaurant chains or improve the package, please open a pull request.

    Visit original content creator repository
    https://github.com/gv3Dev/restaurant-location-search-api