529renew Installing - CameronD73/529renew GitHub Wiki

Installation

There are two methods: the standazrd one is via the Chrome Store. The second (Developer Mode) is only for testing new code, or versions that do not exist in the Chrome store.

via Chrome Store

If you already have 529 and You installed then you should install into a new Chrome profile (see section below)

  • Go to the Chrome store and search for 529renew.
  • Install
  • it will warn about having the ability to modify web pages (this is to insert buttons and such like)
  • it also warns about having the ability to search your history (I have no idea where this comes from - we don't ask for it and as far as I know it doesn't do it) The extension ID is hgckkjajmcmbificinfabmaelboedjic.

Now proceed to the instructions for startup below

In Developer Mode

This is the only way it can be done for versions not in the Chrome store.

These notes were developed under Windows-10. I don't know about MacOS. I refer to Chrome, but Edge should work in a similar way.

To create an installation file from a cloned git repo, copy the Makefile in the utils directory to a spot 2 levels up. Then run make zip and it will create and populate a folder 529revew-V3 as well as a zip file 529renew.zip. You can install the extension directly from that folder, or use the zip file for installing on another computer. Do not install directly from the repo, because Chrome will grab any new files it sees in the install folder.

Extension ID values

Every Chrome extension has a unique identification label, consisting of perhaps 32 lower case letters. This is different between 529 and You, the test versions, and the new one. They will not interfere with each other - they cannot, by design. However you are likely to get very confused having them both installed in the same Chrome profile at the same time.

Every time you install a developer copy from a different folder you will get a different ID and they will look to the system like a different extension. If you unzip new versions into the same folder then Chrome will automatically update when it restarts.

create a new browser profile

This is highly recommended - it will isolate the extension completely from all other extensions and your personal data in your normal profile. It will also reduce the chance of any conflicts between this installation of the code, a new Chrome store installation or the original 529andYou code.

  • click on your profile icon in Chrome and add profile
  • avoid any steps of creating new accounts (Google or Microsoft)
  • choose a colour scheme to make it clear it is not your normal profile.
  • You should rename the profile to something useful, like "529interim", Click on profile icon to customize profile, then in Chrome use the pencil icon to "customize profile"; in Edge ->"manage profile settings" then the 3 dots near "sign in.." to edit settings

install extension

  • Find the latest beta package at https://github.com/CameronD73/529renew, named something like 529renew-v0.1.8-beta.zip. Note the confusing version numbers - V2 or V3 refers to the version of the manifest.json file that defines each Chrome extension. The version of the extension code itself is different.
  • unzip the contents of this extension file into a folder of its own - there are no subfolders
  • go to settings-> extensions in your browser. The fastest way is to just type chrome://extensions/ edge://extensions/ into the address bar.
  • enable "developer mode"
  • find the "load unpacked" button
  • locate the folder you have just unpacked and select it.
  • you should see the alert popup saying it has created a new 529 database.
  • the extension info will report "errors" - clicking on "Errors" should tell you only that manifest V2 is deprecated. Feel free to clear or ignore that error.
  • Note: the info box for the extension will show a random string of letters as the extension's ID. Take a note of this, as it is the extension ID mentioned earlier. It might be useful later as the folder name for the database.

Startup

  • Irrespective of which installation process you follow, the first time you install the extension it will open a new tab labelled "529Renew Results" to create a blank database. It will pop up a message box telling you so, and you will need to click "OK" to continue.
  • The next thing you should do is import your previous database contents from 529 and You.

Database Import (Obsolete pathway)

  • 529renew has a somewhat different database format from that of 529 and You. This is detailed elsewhere in this wiki - most data is the same but it means you cannot simply copy over the old database file.
  • This means you need to reimport your data to easily populate the database with all the matches you carefully obtained with 529 and You.
  • The file that you need to import is the CSV file that you previously exported for GDAT from 529 and You. If you have been using 529 and You for a long time then you may have some "build 36" records. The exports from 529 and You could be from either build 36 or from build 37 but not both in the one file. The files do not contain the build info so you have to know if the file is build 37 or not. Any file you import will be assumed to be build 37.
  • before you import, you should consider the rounding parameters - the cM rounding parameter will be used when importing data. The base-pair address rounding is not used on import.
  • Click on the "Import CSV" button and select the required CSV file. Then wait. This is a ridiculously slow process. If you have a large file and would like progress reports then you can open the debug window using either F12 or ctrl-Shift-I (at least under ms-Windows) and select the console tab.
  • message box eventually says "CSV parsing complete" and you can click OK to continue.
  • you can safely reload the file or load other versions and new entries will be updated. It will ignore matching segments already loaded (which makes it much faster reloading duplicated data), so it would be perhaps safer to load newer files first.
  • you should then be able to examine the show matches of list to see testers who have been imported.