Science Score: 57.0%

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

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

Repository

Basic Info
  • Host: GitHub
  • Owner: marissav06
  • License: mit
  • Language: IDL
  • Default Branch: main
  • Size: 4.5 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 4
Created over 3 years ago · Last pushed over 2 years ago
Metadata Files
Readme License Citation

README.md

Con2020 - Current Sheet Model Code

This repository contains IDL and MATLAB code for the Connerney et al. (2020) Jupiter current sheet model. This is part of a community code project: Magnetospheres of the Outer Planets Group Community Code. For Python versions, please see the stand alone code, or the JupiterMag package.

Citation DOI: 10.5281/zenodo.6981615 (for all releases) Each version release also has its own DOI, click the link above to get to the DOI of specific versions.

Journal Paper DOI: https://doi.org/10.1007/s11214-023-00961-3 (PDF via DOI, or https://rdcu.be/c5I71)

This code provides only the magnetic field due to the current sheet. For the full magnetospheric field one should include a model for Jupiter's internal magnetic field, such as VIP4 or JRM09. You can find IDL code for the JRM09 internal field model here: https://github.com/marissav06/jovianjrm09internal

These codes were developed by Marty Brennan, Stan Cowley, Matt James, Aneesah Kamran, Gabby Provan, Marissa Vogt, and Rob Wilson, with thanks to Fran Bagenal, Jack Connerney, and Masafumi Imai. The codes are intended for use by the Juno science team and other members of the planetary magnetospheres community. Questions, corrections, or other comments can be shared with the authors by emailing mvogt@bu.edu.

These codes uses a right-handed System III (1965) (SYSIII) co-ordinate system (Cartesian or Spherical), and assumes that 1 jovian radius (RJ) = 71,492 km.

Running the code

  • con2020modelrtp calls con2020modelxyz, so download both files locally.
  • With default current sheet model parameter structure: B = con2020modelrtp(eqtype, rrj, colatrads, elongrads)
  • With user-specified current sheet parameters:
    • Obtain the default model parameters: params = con2020modelrtp('defaultvalues')
    • Edit the structure to adjust the model parameters as you wish, e.g. params.r1outerrj = 50.0
      (sets outer edge to 50 RJ; default is 51.4 RJ)
    • Call the function with the adjusted parameter structure: B = con2020modelrtp(eqtype, rrj, colatrads, elongrads, params)
  • For cartesian input/output, use B = con2020modelxyz(eqtype, xrj, yrj, zrj)
  • Required Inputs

    • eqtype - Whether to use the integral or analytic versions of the model equations. Options are 'integral', 'analytic' or 'hybrid', or set to 'defaultvalues' to return a structure of all default values.
    • Position - format depends on whether user is running con2020modelrtp or con2020modelxyz
      • For spherical input:
        • rrj - radial distance, in RJ. Value(s) must be 0 < rrj < 200.
        • colatrads - colatitude, in radians. Value(s) must be 0 <= colatrads <= pi.
        • elongrads - East longitude, right handed, in radians. Value(s) must be 0 <= elongrads <= 2pi.
      • For cartesian input:
        • xrj - SYSIII x position, in RJ, Values must be -200 < xrj < 200.
        • yrj - SYSIII y position, in RJ, Values must be -200 < xrj < 200.
        • zrj - SYSIII z position, in RJ, Values must be -200 < xrj < 200.
      • Note: for spherical input, rrj, colatrads and elongrads can be scalars or 1D arrays, but only one eqtype. For cartesian input, xrj, yrj and zrj can be scalars or 1D arrays, but only one eqtype. For MATLAB, the 1D arrays must be size (n x 1), not (1 x n).

    Optional inputs (e.g. in structure con2020_model_rtp('default_values'))

    Variable name Description Default value
    mu_i_div2__current_parameter_nT mu0i0/2 term (current sheet field parameter) 139.6 nT
    i_rho__radial_current_MA radial current term from Connerney et al., 2020 (set this to zero to turn radial currents off as in Connerney et al. 1981) 16.7 MA
    r0__inner_rj inner edge of current disk in RJ 7.8 RJ
    r1__outer_rj outer edge of current disk in RJ 51.4 RJ
    d__cs_half_thickness_rj D, current sheet half thickness 3.6 RJ
    xt__cs_tilt_degs current sheet tilt angle 9.3 degrees
    xp__cs_rhs_azimuthal_angle_of_tilt_degs azimuthal angle of the current sheet tilt (right handed) 155.8 degrees right handed (corresponds to 204.2 degrees left handed longitude)
    error_check 1 to check that inputs are valid (Default), or set to 0 to skip input checks (faster) 1

    Outputs

    • The code outputs a vector that contains the 3 components of the magnetic field produced by the current sheet, in SIII right-handed.
    • For con2020_model_rtp (spherical input/output) the vector is [Br, Btheta, Bphi] in nT.
    • For con2020_model_xyz (cartesian input/output) the vector is [Bx, By, Bz] in nT.

    History

    This repository was made by merging a previous IDL specific and a Matlab specific repository.

    References:

    • Connerney, J. E. P., Acuña, M. H., & Ness, N. F. (1981). Modeling the Jovian current sheet and inner magnetosphere. Journal of Geophysical Research, 86, 8370-8384. https://doi.org/10.1029/JA086iA10p08370
    • Connerney, J. E. P., Timmins, S., Herceg, M., & Joergensen, J. L. (2020). A Jovian magnetodisc model for the Juno era. Journal of Geophysical Research: Space Physics, 125, e2020JA028138. https://doi.org/10.1029/2020JA028138
    • Edwards, T. M., Bunce, E. J., & Cowley, S. W. H. (2001). A note on the vector potential of Connerney et al.'s model of the equatorial current sheet in Jupiter's magnetosphere. Planetary and Space Science, 49, 1115– 1123. https://doi.org/10.1016/S0032-0633(00)00164-1
    • Wilson, R.J., Vogt, M.F., Provan, G. et al. Internal and External Jovian Magnetic Fields: Community Code to Serve the Magnetospheres of the Outer Planets Community. Space Sci Rev 219, 15 (2023). https://doi.org/10.1007/s11214-023-00961-3

    Owner

    • Name: Marissa Vogt
    • Login: marissav06
    • Kind: user
    • Company: Boston University

    Senior Research Scientist in Planetary Space Physics

    Citation (CITATION.cff)

    # This CITATION.cff file was based on one generated with cffinit.
    # Visit https://bit.ly/cffinit to generate yours today!
    
    cff-version: 1.2.0
    title: 'Con2020 - Current Sheet Model Code'
    message: >-
      If you use this software, please cite it using the
      metadata from this file.
    type: software
    authors:
      - given-names: 'M.F. '
        family-names: Vogt
        orcid: 'https://orcid.org/0000-0003-4885-8615'
        affiliation: >-
          Center for Space Physics, Boston University,
          Boston, MA, USA
        email: mvogt@bu.edu
      - given-names: R.J.
        family-names: Wilson
        email: rob.wilson@lasp.colorado.edu
        affiliation: >-
          Laboratory for Atmospheric and Space Physics,
          University of Colorado Boulder, Boulder,
          Colorado, USA
        orcid: 'https://orcid.org/0000-0001-9276-2368'
      - given-names: G.
        family-names: Provan
        email: gp31@le.ac.uk
        affiliation: >-
          School of Physics and Astronomy, University
          of Leicester, Leicester, UK
        orcid: 'https://orcid.org/0000-0001-7442-4154'
      - given-names: A.
        family-names: Kamran
        email: ak741@leicester.ac.uk
        orcid: 'https://orcid.org/0000-0003-3736-9680'
        affiliation: >-
          School of Physics and Astronomy, University
          of Leicester, Leicester, UK
      - affiliation: >-
          School of Physics and Astronomy, University
          of Leicester, Leicester, UK
        given-names: M.K.
        family-names: James
        email: mkj13@leicester.ac.uk
        orcid: 'https://orcid.org/0000-0002-5699-6121'
      - given-names: M.J.
        family-names: Brennan
        email: martin.brennan@jpl.nasa.gov
        orcid: 'https://orcid.org/0000-0003-0796-4251'
        affiliation: >-
          Jet Propulsion Laboratory, California Institute
          of Technology, Pasadena, CA, USA
      - affiliation: >-
          School of Physics and Astronomy, University
          of Leicester, Leicester, UK
        orcid: 'https://orcid.org/0000-0002-4041-0034'
        email: swhc1@leicester.ac.uk
        family-names: Cowley
        given-names: S.W.H.
    identifiers:
      - type: doi
        value: 10.5281/zenodo.6981615
        description: >-
          This DOI represents all software versions, and
          will always resolve to the latest one. 
    repository-code: 'https://github.com/marissav06/con2020'
    

    GitHub Events

    Total
    Last Year